From 7bbd724bff3e57f1a3bd517bb2bf3ccc945b693d Mon Sep 17 00:00:00 2001 From: gcolpart Date: Wed, 29 Nov 2017 19:53:41 +0100 Subject: [PATCH] ajout --- Syntaxe.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Syntaxe.md b/Syntaxe.md index d68ad060..94056e77 100644 --- a/Syntaxe.md +++ b/Syntaxe.md @@ -120,10 +120,13 @@ Par défaut on considère que l'on écrit de la documentation pour la version *s * 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 * 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 / Optimisation / Plomberie / Monitoring / FAQ -* L'organisation des titres/sous-titres doit avoir une cohérence +* En général, il doit y avoir au moins les titres : Installation / Configuration / Administration / Optimisation / Plomberie / Monitoring (avec sous-titres Munin et Nagios) / FAQ +* L'organisation des titres/sous-titres doit être cohérente quand on regarde la table des titres * 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 +* Si l'on mentionne des autres documentations, mettre des liens internes +* Objectif 0 faute d'orthographe +* Tout ce qu'on a mis en production sur des serveurs doit être mentionné * 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]()