Platform Build¶
Doel¶
De platform build genereert en publiceert de technische documentatie van LASPECT IT.
Standaardcommando¶
cd /Users/oscar/engineering-handbook
./scripts/build/build-platform-docs.sh
Wat doet het script?¶
- Synchroniseert
automation-scriptsnaarmanage. - Genereert documentatie op
manage. - Haalt gegenereerde Markdown terug naar de Mac.
- Bouwt MkDocs lokaal.
- Publiceert naar
docs.laspect.nl.
Vereisten¶
- SSH-toegang vanaf de Mac naar
manage.laspect.nl. - Werkende Python 3.13 op
manage. - Lokale MkDocs virtual environment in
engineering-handbook/.venv. - Werkende sudo-regel voor documentatie-deploy.
inventoryeninfrastructure-configsactueel opmanage.
Validatie¶
mkdocs build --strict
curl -I https://docs.laspect.nl
Fouten oplossen¶
Permission denied op generated output¶
Gebruik /tmp/laspect-generated-docs als remote outputpad.
MkDocs pagina ontbreekt in nav¶
Voeg de pagina toe aan mkdocs.yml.
Python module ontbreekt¶
Synchroniseer automation-scripts opnieuw naar manage.