docs: Updated module docs with latest versions. (#35)

docs: Reorganize docs to remove hard-coded nav.
codeforamerica · Jan 13, 2025 · 94a5c50 · 94a5c50
1 parent 4d3bed1
commit 94a5c50
Show file tree

Hide file tree

Showing 13 changed files with 22 additions and 31 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -34,6 +34,6 @@ jobs:
           path: .cache
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs-material markdown-callouts pymdown-extensions plantuml_markdown
+      - run: pip install mkdocs-material markdown-callouts mkdocs-nav-weight pymdown-extensions plantuml_markdown
       - run: mkdocs build
       - run: aws s3 sync ./site "s3://${{ env.BUCKET_NAME || 'dev.docs.cfa.codes' }}/${{ env.PREFIX || 'tofu-modules' }}"
diff --git a/Dockerfile b/Dockerfile
@@ -1,7 +1,7 @@
 FROM squidfunk/mkdocs-material:9.5
 
 # Install PlantUML so we can render UML diagrams.
-RUN pip install markdown-callouts plantuml_markdown
+RUN pip install markdown-callouts mkdocs-nav-weight plantuml_markdown
 RUN apk add --no-cache plantuml --repository=https://dl-cdn.alpinelinux.org/alpine/edge/community \
     && rm -rf /var/cache/apk/*
 

diff --git a/aws/cloudfront_waf b/aws/cloudfront_waf
diff --git a/aws/vpc b/aws/vpc
diff --git a/datadog/waf b/datadog/waf
diff --git a/docs/about/index.md b/docs/about/index.md
@@ -0,0 +1,5 @@
+---
+title: Contributing
+weight: 100
+---
+--8<-- "CONTRIBUTING.md"
diff --git a/docs/about/license.md b/docs/about/license.md
@@ -0,0 +1,5 @@
+---
+weight: 100
+index_weight: 100
+---
+--8<-- "LICENSE"
diff --git a/docs/architecture/architecture.md → docs/architecture/index.md b/docs/architecture/architecture.md → docs/architecture/index.md
@@ -1,4 +1,4 @@
-# Architecture
+# Architecture Overview
 
 ## File structure
 

diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,6 @@
+---
+title: Home
+---
 --8<-- "README.md"
 
 [aptible-managed-endpoint]: modules/aptible/managed-endpoint.md
@@ -8,5 +11,5 @@
 [aws-secrets]: modules/aws/secrets.md
 [aws-serverless-database]: modules/aws/serverless-database.md
 [aws-vpc]: modules/aws/vpc.md
-[contributing]: contributing.md
+[contributing]: about/index.md
 [datadog-waf]: modules/datadog/waf.md
diff --git a/docs/license.md b/docs/license.md
diff --git a/docs/modules/datadog/waf.md b/docs/modules/datadog/waf.md
@@ -1,3 +1,3 @@
 --8<-- "datadog/waf/README.md"
 
-[screenshot-dashboard]: ../../assets/dashboard.jpeg
+[screenshot-dashboard]: ../../assets/dashboard.png
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -3,6 +3,7 @@ repo_url: https://github.com/codeforamerica/tofu-modules
 edit_uri: edit/main/docs/
 
 plugins:
+  - mkdocs-nav-weight
   - search
 
 markdown_extensions:
@@ -60,25 +61,4 @@ extra:
       link: https://www.threads.net/@codeforamerica
       name: Code for America on X (formerly Twitter)
 
-nav:
-  - Home: index.md
-  - Architecture:
-      - Overview: architecture/architecture.md
-      - Create a New Module: architecture/create.md
-      - GitHub Actions: architecture/github-actions.md
-  - Modules:
-      - Aptible:
-          - Managed Endpoint: modules/aptible/managed-endpoint.md
-      - AWS:
-          - Backend: modules/aws/backend.md
-          - CloudFront WAF: modules/aws/cloudfront-waf.md
-          - Fargate Service: modules/aws/fargate-service.md
-          - Logging: modules/aws/logging.md
-          - Secrets: modules/aws/secrets.md
-          - Serverless Database: modules/aws/serverless-database.md
-          - VPC: modules/aws/vpc.md
-  - About:
-      - Contributing: contributing.md
-      - License: license.md
-
 copyright: Produced by Code for America under the MIT license.
+1 −1		.cz.yaml
+12 −0		CHANGELOG.md
+96 −9		README.md
+6 −2		data.tf
+40 −30		main.tf
+0 −0		uploads.tf
+25 −0		variables.tf
+211 −0		webhooks.tf
+1 −1		.cz.yaml
+2 −0		.github/workflows/release.yaml
+6 −0		CHANGELOG.md
+2 −2		README.md
+6 −0		main.tf
+1 −1		.cz.yaml
+10 −0		CHANGELOG.md
+11 −1		README.md
+ −		docs/assets/dashboard.jpeg
+ −		docs/assets/dashboard.png
+240 −59		templates/dashboard.yaml.tftpl