crans
/
documentation
mirror of https://gitlab.crans.org/nounous/documentation.git
19
0
Fork 0
Code Issues Projects Releases Wiki Activity

[CONTRIBUTE.md] howto à la racine

ceph
_benjamin 2021-04-30 10:00:42 +02:00 committed by Benjamin Graillot
parent 6623ad6897
commit 8738306256
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTE.md
View File

@ -6,7 +6,7 @@ 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 * `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 d'outils : TLS, APT, debian, rsync, ssh, … À mettre dans `/tools`
* Exemples de connaissances : IP, Firewall, NAT, DHCP, … À mettre dans `/tools` * Exemples de connaissances : IP, Firewall, NAT, DHCP, … À mettre dans `/tools`
* Exemples d'autres pages : acheter un disque, … À mettre dans `/tools/howto` * `howto`: dans cette section, on regroupe les connaissances pratiques utiles : acheter un disque, dimensionner une clim, …
* `infrastructure`: ici on décrit l'infrastructure dans sa globalité, pour faire simple ce que le Crans met à disposition du Crans * `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 * Exemples : LDAP administration, NFS, Plan IP & VLAN, matériel technique, PostgreSQL
* `services`: on y décrit la liste des services offerts aux adhérents * `services`: on y décrit la liste des services offerts aux adhérents
@ -14,4 +14,4 @@ La documentation a la structure suivante
## Contribuer ## Contribuer
Pour contribuer rien de plus simple : il suffit de créer un fichier `.md` (en Markdown) dans la section idoine. 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`. On priviliégiera des noms de fichier en minuscules et le plus simple possible : par exemple acheter un disque → `/howto/disk.md`.