diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 739d4a8..5c3dcd4 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -44,9 +44,21 @@ jobs: chmod +x scripts/docs/*.sh scripts/docs/generate-all.sh - - name: Build MkDocs site + - name: Build public MkDocs site run: | - python3 -m mkdocs build --strict + python3 -m mkdocs build -f mkdocs-public.yml --strict + + - name: Verify published content excludes internal/generated docs + run: | + test -d site-public + test ! -e site-public/generated + test ! -e site-public/docker + + - name: Verify expected 404-only paths are not generated + run: | + test ! -e site-public/generated/compose-inventory/index.html + test ! -e site-public/generated/prometheus-rules/index.html + test ! -e site-public/docker/index.html - name: Configure GitHub Pages uses: actions/configure-pages@v5 @@ -54,7 +66,7 @@ jobs: - name: Upload GitHub Pages artifact uses: actions/upload-pages-artifact@v3 with: - path: site + path: site-public deploy: runs-on: ubuntu-latest diff --git a/mkdocs-public.yml b/mkdocs-public.yml new file mode 100644 index 0000000..9315745 --- /dev/null +++ b/mkdocs-public.yml @@ -0,0 +1,19 @@ +site_name: Public Infrastructure Documentation +site_description: Public-facing infrastructure documentation +repo_url: https://github.com/beatz174-bit/docker +site_url: https://beatz174-bit.github.io/docker/ +docs_dir: docs/public +site_dir: site-public + +nav: + - Home: index.md + - Compose Inventory: compose-inventory.md + - Traefik Routes: traefik-routes.md + - Prometheus Rules: prometheus-rules.md + +theme: + name: mkdocs + +validation: + nav: + omitted_files: ignore