documentation/CONTRIBUTE.md

1.0 KiB

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
  • 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
    • 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 → /howto/disk.md.