Ga naar inhoud

Gegenereerde documentatie

Doel

Een deel van het handboek wordt automatisch gegenereerd vanuit de inventory-repository.

Bronnen

Bron Doel
inventory/servers.yml Servers, rollen en services
inventory/domains.yml Publieke hostnamen en koppelingen
automation-scripts/scripts/inventory2mermaid.py Generator voor Markdown en Mermaid

Genereren

cd ~/automation-scripts
source .venv/bin/activate

python3 scripts/inventory2mermaid.py \
  --inventory ~/inventory/inventory \
  --output ~/engineering-handbook/docs/generated

Publiceren

cd ~/engineering-handbook
git add docs/generated
git commit -m "Update generated inventory documentation"
git push origin main
./scripts/deploy/deploy-docs.sh