Skip to content

Commit

Permalink
Update Terraform docs rendering and collapse sidebar items
Browse files Browse the repository at this point in the history
  • Loading branch information
milldr committed Aug 1, 2024
1 parent 5fd05d7 commit 0d7e545
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 9 deletions.
8 changes: 2 additions & 6 deletions scripts/docs-collator/ModuleRenderer.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,8 @@ def __render_readme(self, module_download_dir, module_docs_dir):

io.create_dirs(module_docs_dir)

# Copy the local terraform-docs configuration file to the module directory
# so that make readme uses that configuration
# io.copy_file(
# os.path.join(TEMPLATES_DIR, "terraform-docs.yml"),
# os.path.join(module_download_dir, ".terraform-docs.yml"),
# )
# Re-render terraform docs with this repo's terraform-docs template for modules.
# This replaces docs/terraform.md for the given module in place
rendering.render_terraform_docs(
module_download_dir, os.path.join(TEMPLATES_DIR, "terraform-docs.yml")
)
Expand Down
2 changes: 1 addition & 1 deletion scripts/render-docs-for-github-actions.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ usage() {

[ -z "${PUBLIC_REPO_ACCESS_TOKEN}" ] && usage "PUBLIC_REPO_ACCESS_TOKEN"

RENDERED_DOCS_DIR="${RENDERED_DOCS_DIR:-content/reference/github-actions/library}"
RENDERED_DOCS_DIR="${RENDERED_DOCS_DIR:-docs/github-actions/library}"
DOWNLOAD_TMP_DIR="${DOWNLOAD_TMP_DIR:-tmp/github-actions}"

python scripts/docs-collator/render_docs_for_github_actions.py \
Expand Down
4 changes: 2 additions & 2 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ module.exports = {
label: 'Terraform Components',
className: 'sidebar-title',
collapsible: true,
collapsed: false,
collapsed: true,
link: {
type: 'doc',
id: 'components/components'
Expand All @@ -471,7 +471,7 @@ module.exports = {
label: 'Terraform Modules',
className: 'sidebar-title',
collapsible: true,
collapsed: false,
collapsed: true,
link: {
type: 'doc',
id: 'modules/modules'
Expand Down

0 comments on commit 0d7e545

Please sign in to comment.