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

Ajout de CONTRIBUTE.md

ceph
_benjamin 2021-04-29 11:04:19 +02:00 committed by Benjamin Graillot
parent 435aa46ab2
commit edcc138dd8
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTE.md 100644
View File

@ -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`.