Ga naar inhoud

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?

  1. Synchroniseert automation-scripts naar manage.
  2. Genereert documentatie op manage.
  3. Haalt gegenereerde Markdown terug naar de Mac.
  4. Bouwt MkDocs lokaal.
  5. 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.
  • inventory en infrastructure-configs actueel op manage.

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.