Passa al contenuto principale

Docs Site Deploy

Il portale documentale Akira e' un build statico Docusaurus servito da Caddy su docs.{app_domain}.

Prerequisiti​

  • Eseguire il cutover dal Mac, perche' il runner non raggiunge staging.
  • Avere una working tree aggiornata con docs-site/build/ generato localmente.
  • Non rimuovere ancora la pagina Next.js apps/frontend/src/app/(public)/docs/page.tsx: resta fallback fino a verifica cutover.

Build locale​

pnpm install
pnpm --filter docs-site gen-api
pnpm --filter docs-site build

Rigenerare sempre la API Reference quando cambia il contratto FastAPI: il comando pnpm --filter docs-site gen-api esporta docs-site/openapi/akira.json, pubblica la copia scaricabile in docs-site/static/openapi/akira.json e aggiorna le pagine MDX generate da OpenAPI. Non modificare a mano i file in docs-site/docs/api-reference/generated/.

Deploy management​

Il ruolo Caddy copia il contenuto di docs-site/build/ dal controller Ansible verso {{ docs_site_root }}/build/. Il template Caddy serve root * {{ docs_site_root }}/build con file_server.

pnpm --filter docs-site build
ansible-playbook -i infra/inventory/staging.yml infra/playbooks/deploy_management.yml --tags caddy

Verifica​

curl -I https://docs.akira-staging.asheep.it/
curl -I https://docs.akira-staging.asheep.it/docs/overview

Atteso: HTTP 200/3xx valido da Caddy, contenuti Docusaurus visibili e nessun proxy verso la route Next.js /docs.