Vai al contenuto

Build Docs in locale

Prerequisiti

pip install -r requirements-docs.txt

Avvio locale

mkdocs serve

Porta default: http://127.0.0.1:8000

Build statica

python tools/generate_release_notes.py
mkdocs build

Output: cartella site/

CI/CD

  • Workflow: .github/workflows/docs.yml
  • Su PR:
  • build docs in strict mode
  • guard aggiornamento docs/changelog con tools/check_docs_guard.py
  • verifica allineamento docs/release_notes.md da tools/generate_release_notes.py
  • Su push main/master:
  • build + publish su GitHub Pages

Deploy self-host (dominio tuo)

  • Workflow dedicato: .github/workflows/docs-selfhost.yml
  • Guida setup: docs/DEPLOY_DOCS_SELFHOST.md
  • Deploy via SSH + rsync su path remoto configurato da secrets.

Deploy automatico locale (stesso server)

Script pronto:

deploy/scripts/deploy_docs_local.sh

Unit/timer systemd pronti:

  • deploy/systemd/safeops-docs-build.service
  • deploy/systemd/safeops-docs-build.timer

Operativita runtime

Riferimento rapido per servizi, porte, domini e verifiche:

  • docs/OPERATIONS_RUNTIME.md