Eirbware mkdocs

Ceci est le dépôt de docs.eirb.fr, le but est de documenter les comment fonctionne Eirbware, et surtout le pourquoi Eirbware fonctionne de cette façon.

Documentation pour créer de la documentation

On utilise le conteneur de "Material for MKdocs", des plugins sont préinstallés, et quelques fonctionnalités sont ajoutées, pour plus d'infos, c'est dans le lien suivant : https://squidfunk.github.io/mkdocs-material/getting-started/

Développement

Ce dépôt utilise docker afin de compiler et de créer un environnement de développement.

Le but étant de ne pas avoir à installer mkdocs pour pouvoir contribuer à ce dépôt. De plus, il suffit d'exécuter la commande suivante pour supprimer les fichiers compilés et les images docker téléchargées :

make mrproper

Démarrer le serveur de développement

mkdocs propose un serveur de développement, il peut être démarré en faisant :

make dev

Modifications du site

Après avoir lancé le serveur de développement, il suffit de modifier les fichiers markdown du dossier mkdocs.

Production

Comme énoncé précédemment, le serveur proposé par mkdocs n'est pas fait pour un environnement de production. Le site doit être compilé puis servi statiquement par un serveur comme nginx.

Compilation

Afin de compiler le site pour la production, faites :

make build

Déploiement

Normalement, il suffit d'uploader en SFTP le site compilé dans le dossier ~www-docs/nginx/www sur le serveur d'Eirbware.