Portail de documentation

Le portail technique est construit avec Material for MkDocs et servi en production par une image nginx separee de l'application Symfony.

Contenu publie

• les pages Markdown presentes dans docs/ ;
• la reference PHP generee par phpDocumentor depuis src/ ;
• aucune variable d'environnement et aucun secret.

Image Docker

Le Dockerfile docker/docs/Dockerfile contient trois stages :

1. phpdoc genere docs/api-reference/ depuis le code PHP ;
2. mkdocs construit le site statique ;
3. runtime sert le resultat avec nginx.

En CI, l'image docs est taguee avec le meme tag immuable que l'image applicative, par exemple sha-a1b2c3d.

Developpement local

docker compose --profile docs up docs-static --build

Le site statique est alors expose sur http://localhost:8088. Pour consulter le site avec le serveur MkDocs integre a l'image :

docker compose --profile docs up docs --build

Le serveur MkDocs ecoute sur http://localhost:8008.

Production

Le service bconnect-business-docs est expose par Traefik sur :

https://docs.bconnect-business.169.58.138.150.nip.io

La valeur effective se configure avec DOCS_HOST dans le .env serveur. Le workflow injecte DOCS_IMAGE dans un fichier d'environnement temporaire pendant le deploiement.