diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 747026e..4b30834 100644 --- 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 index e2c3b9b..d465dbd 100644 --- 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 index be3fe84..3e6fc57 160000 --- a/aws/cloudfront_waf +++ b/aws/cloudfront_waf @@ -1 +1 @@ -Subproject commit be3fe848b2aea288b5ff3519cc3d2ce9492ce302 +Subproject commit 3e6fc5760a00b704377f90b4358b7c39b15955ee diff --git a/aws/vpc b/aws/vpc index 72940c9..1dcd935 160000 --- a/aws/vpc +++ b/aws/vpc @@ -1 +1 @@ -Subproject commit 72940c938781fef018dd75449abc4b4e4de7f77d +Subproject commit 1dcd9355f5f04d1c8d4ad27f1433535a13c18ad1 diff --git a/datadog/waf b/datadog/waf index e523fac..0006552 160000 --- a/datadog/waf +++ b/datadog/waf @@ -1 +1 @@ -Subproject commit e523fac6899383bffd62ab2f113e4d9f3d4fcf15 +Subproject commit 0006552243cff9bf98dd308cfadcd6d4e128d084 diff --git a/docs/about/index.md b/docs/about/index.md new file mode 100644 index 0000000..1963491 --- /dev/null +++ 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 new file mode 100644 index 0000000..f208540 --- /dev/null +++ b/docs/about/license.md @@ -0,0 +1,5 @@ +--- +weight: 100 +index_weight: 100 +--- +--8<-- "LICENSE" diff --git a/docs/architecture/architecture.md b/docs/architecture/index.md similarity index 99% rename from docs/architecture/architecture.md rename to docs/architecture/index.md index fefb142..020581c 100644 --- a/docs/architecture/architecture.md +++ b/docs/architecture/index.md @@ -1,4 +1,4 @@ -# Architecture +# Architecture Overview ## File structure diff --git a/docs/contributing.md b/docs/contributing.md deleted file mode 100644 index ea38c9b..0000000 --- a/docs/contributing.md +++ /dev/null @@ -1 +0,0 @@ ---8<-- "CONTRIBUTING.md" diff --git a/docs/index.md b/docs/index.md index 1262409..d5e46c1 100644 --- 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 deleted file mode 100644 index f409d45..0000000 --- a/docs/license.md +++ /dev/null @@ -1 +0,0 @@ ---8<-- "LICENSE" diff --git a/docs/modules/datadog/waf.md b/docs/modules/datadog/waf.md index 455286b..407dec8 100644 --- 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 index f92ed28..4c47502 100644 --- 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.