MkDocs - Pipeline#
Le pipeline docs-ci est utilisé pour déployer les instances de la documentation docs-internal et docs-clients.
Repos Git#
- docs-ci : le pipeline.
- docs-internal, docs-clients : la documentation interne/client au format markdown
- mkdocs-material-with-plugins : le Dockerfile de l'image MkDocs avec les plugins, utilisée pour compiler la doc markdown -> html
- envs-ng/http_proxy.cue : la conf de l'API Gateway utilisée pour faire la redirection docs.caascad.com -> docs-clients.corp.caascad.com
Fonctionnement du pipeline#
Voir https://git.corp.caascad.com/caascad/applications/docs-ci/-/blob/master/README.md.
Mise à jour de MkDocs#
Voir https://squidfunk.github.io/mkdocs-material/upgrade/.
Il faudra ensuite :
- builder la nouvelle image mkdocs-material-with-plugins ;
- mettre à jour le tag de l'image utilisée dans le pipeline : https://git.corp.caascad.com/caascad/applications/docs-ci/-/blob/master/pipeline/pipeline.cue#L39 ;
- mettre à jour le tag de l'image utilisée dans le script run.sh : docs-internal/run.sh et docs-clients/run.sh.