Référence¶
Nommage¶
Machines¶
Il s'agit de la machine sur laquelle on développe.
Ça peut être macOS, Linux ou Windows.
Il s'agit de la machine virtuelle dans laquelle le projet Efalia Doc est exécuté dans un environnement de développement.
Techniquement elle est exécutée dans VirtualBox et Vagrant n'est qu'un outil qui pilote cette machine virtuelle.
Vagrant est donc un abus de langage mais c'est le terme communément utilisé par l'équipe.
Il s'agit de n'importe quelle machine virtuelle qui exécute Efalia Doc dans un environnement de production.
On ne fait ici pas de distinction entre les différents environnements d'un point de vue client.
Par exemple cd55-prod et cd55-test sont toutes les deux des Production.
Style¶
Lignes de commandes¶
Dans beaucoup de documentations on expose des lignes de commandes à exécuter sur nos machines. Cependant certaines doivent être lancées sur notre machine hôte, d'autres dans vagrant, ou encore sur la machine de production.
Afin que cela soit le plus explicite possible chaque lignes de commandes sont placées dans des onglets où le nom indique l'endroit où elle doit être lancée. Par exemple :
Même s'il n'y a qu'une seule commande on crée un seul onglet.
Cela nous permet d'identifier localement où on doit lancer la commande sans devoir faire référence à la documentation. L'absence de préfixe de la commande permet également de copier plus facilement la commande.
ADR¶
Chaque nouvel ADR doit être rangé dans un dossier dans blog/posts/ dont le nom correspond à la catégorie principale du document.
Les ADR qui ne sont plus d'actualités doivent ajouter une catégorie Déprécié et ajouter le message suivant en début du document :
Ce document est déprécié.