ajout
This commit is contained in:
parent
9db24ca2e5
commit
e85e67210e
|
@ -117,13 +117,15 @@ Par défaut on considère que l'on écrit de la documentation pour la version *s
|
||||||
* Si une documentation officielle existe, elle doit être notée tout en haut sous la forme : Documentation : <lien>
|
* Si une documentation officielle existe, elle doit être notée tout en haut sous la forme : Documentation : <lien>
|
||||||
* Si un rôle Ansible existe, il doit être noté avec le lien vers la branche stable sur la forge sous la forme : Rôle Ansible : <lien>
|
* Si un rôle Ansible existe, il doit être noté avec le lien vers la branche stable sur la forge sous la forme : Rôle Ansible : <lien>
|
||||||
* La description doit être succinte (entre 3 et 10 lignes) ET subjective d'un point de vue Evolix
|
* La description doit être succinte (entre 3 et 10 lignes) ET subjective d'un point de vue Evolix
|
||||||
|
* Un lien vers le site officiel doit être positionné sur la 1ère occurence du nom de la techno dans la description.
|
||||||
* Une section installation doit être présente. On considère que l'on est en Debian 9 par défaut, si besoin on précise les exceptions pour Debian 7 ou 8 comme précisé plus haut
|
* Une section installation doit être présente. On considère que l'on est en Debian 9 par défaut, si besoin on précise les exceptions pour Debian 7 ou 8 comme précisé plus haut
|
||||||
* Dans la section installation, on montrer la commande apt d'installation, mais un moyen d'obtenir la version installée en temps qu'utilisateur non-root et l'état de l'éventuel démon avec sysctemctl status SAUF la ligne "active"
|
* Dans la section installation, on montrer la commande apt d'installation, mais un moyen d'obtenir la version installée en temps qu'utilisateur non-root et l'état de l'éventuel démon avec sysctemctl status SAUF la ligne "active"
|
||||||
* En général, il doit y avoir au moins les titres : Installation / Configuration / Administration / Plomberie / Monitoring / FAQ
|
* En général, il doit y avoir au moins les titres : Installation / Configuration / Administration / Optimisation / Plomberie / Monitoring / FAQ
|
||||||
* L'organisation des titres/sous-titres doit avoir une cohérence
|
* L'organisation des titres/sous-titres doit avoir une cohérence
|
||||||
* Les conventions de syntaxe doivent être appliquées partout (voir ci-dessous) notamment pour les adresses IP, les "Note :", les fichiers sous la forme `/etc/foo.conf` etc.
|
* Les conventions de syntaxe doivent être appliquées partout (voir ci-dessous) notamment pour les adresses IP, les "Note :", les fichiers sous la forme `/etc/foo.conf` etc.
|
||||||
* Les exemples de code ou contenu de fichiers doivent utiliser la syntaxe avec trois tildes
|
* Les exemples de code ou contenu de fichiers doivent utiliser la syntaxe avec trois tildes
|
||||||
* Si la doc est longue, on hésitera pas à avoir un titre "Configuration de base" et "Configuration avancée", ou alors un sous-titre "Utilisation de base" avec les commandes de base si l'on doit lire la doc en 1 minute
|
* Si la doc est longue, on hésitera pas à avoir un titre "Configuration de base" et "Configuration avancée", ou alors un sous-titre "Utilisation de base" avec les commandes de base si l'on doit lire la doc en 1 minute
|
||||||
|
* Si la doc est très longue, elle peut être découpée en sous-pages à l'exemple du [HowtoMySQL]()
|
||||||
|
|
||||||
À titre d'exemple, on pourra prendre le [HowtoApache]()
|
À titre d'exemple, on pourra prendre le [HowtoApache]()
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue