docs: publish only docs/public to GitHub Pages
This commit is contained in:
@@ -44,9 +44,21 @@ jobs:
|
|||||||
chmod +x scripts/docs/*.sh
|
chmod +x scripts/docs/*.sh
|
||||||
scripts/docs/generate-all.sh
|
scripts/docs/generate-all.sh
|
||||||
|
|
||||||
- name: Build MkDocs site
|
- name: Build public MkDocs site
|
||||||
run: |
|
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
|
- name: Configure GitHub Pages
|
||||||
uses: actions/configure-pages@v5
|
uses: actions/configure-pages@v5
|
||||||
@@ -54,7 +66,7 @@ jobs:
|
|||||||
- name: Upload GitHub Pages artifact
|
- name: Upload GitHub Pages artifact
|
||||||
uses: actions/upload-pages-artifact@v3
|
uses: actions/upload-pages-artifact@v3
|
||||||
with:
|
with:
|
||||||
path: site
|
path: site-public
|
||||||
|
|
||||||
deploy:
|
deploy:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|||||||
@@ -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
|
||||||
Reference in New Issue
Block a user