Portail de documentation¶

Le portail de documentation est un service separe de l'application Symfony. Il compile les pages Markdown avec Material for MkDocs, genere la reference PHP avec phpDocumentor, puis sert le site statique avec nginx en production.

Construction locale¶

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

Le site statique est alors disponible localement sur http://localhost:8089. 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:8009.

Production¶

Le workflow GitHub Actions construit deux images avec le meme IMAGE_TAG :

Image	Usage
`binn.registry.169.58.138.150.nip.io/binn/bconnect-pos`	application Symfony
`binn.registry.169.58.138.150.nip.io/binn/bconnect-pos-docs`	portail docs nginx

Le deploiement ecrit POS_IMAGE et DOCS_IMAGE dans le fichier d'environnement transitoire de CI, puis redemarre la stack avec docker-compose.prod.yml.

URL¶

DOCS_HOST permet de remplacer l'hote Traefik. Sans surcharge, l'URL publique est :

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

Le service docs est rattache a traefik-net et expose uniquement le port interne nginx 80 a Traefik.

Contenu publie¶

Les pages Markdown du repertoire docs/.
La reference PHP generee depuis src/ dans docs/api-reference/.
Aucun fichier .env, cle JWT, upload ou secret local n'est copie dans l'image.