From edcc138dd827a5757fda7440ae147a44a55b1686 Mon Sep 17 00:00:00 2001 From: Benjamin Graillot Date: Thu, 29 Apr 2021 11:04:19 +0200 Subject: [PATCH] Ajout de CONTRIBUTE.md --- CONTRIBUTE.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTE.md diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md new file mode 100644 index 0000000..d16b9d7 --- /dev/null +++ b/CONTRIBUTE.md @@ -0,0 +1,17 @@ +# Contribute + +## Structure + +La documentation a la structure suivante + * `tools`: dans cette section, on rassemble tous les outils utilisés et les descriptions de certains protocoles utilisés + * Exemples d'outils : TLS, APT, debian, rsync, ssh, … À mettre dans `/tools` + * Exemples de connaissances : IP, Firewall, NAT, DHCP, … À mettre dans `/tools` + * Exemples d'autres pages : acheter un disque, … À mettre dans `/tools/howto` + * `infrastructure`: ici on décrit l'infrastructure dans sa globalité, pour faire simple ce que le Crans met à disposition du Crans + * Exemples : LDAP administration, NFS, Plan IP & VLAN, matériel technique, PostgreSQL + * `services`: on y décrit la liste des services offerts aux adhérents + +## Contribuer + +Pour contribuer rien de plus simple : il suffit de créer un fichier `.md` (en Markdown) dans la section idoine. +On priviliégiera des noms de fichier en minuscules et le plus simple possible : par exemple acheter un disque → `/tools/howto/disk.md`.