/doc-infra

Documentation for the infra team

Primary LanguagePython

Documentation de l'infrastructure de Polytechnique.org

Ce projet contient la documentation technique des services de Polytechnique.org, sous une forme publique et partageable.

Le dépôt Github du projet est https://github.com/Polytechnique-org/doc-infra et les pages générées (avec Sphinx) sont disponibles sur https://doc.polytechnique.org/infra/.

Cela est utile :

  • Lorsque des personnes veulent mettre en place chez eux des composants qui sont déjà en place à Polytechnique.org et demandent comment ils sont configurés.
  • Dans les tâches d'administration, pour avoir quelques commandes utiles par exemple pour gérer Mailman (pour les listes de diffusion).
  • Pour former de nouveaux membres de l'équipe d'administration, qui peuvent aller voir par eux-mêmes la documentation sans devoir attendre d'avoir des droits spécifiques.

Ce projet ne contient pas :

  • Les mots de passes et noms d'utilisateurs personnalisés sur les serveurs, pour des raisons évidentes de sécurité. Il peut y avoir des exemples de commandes avec les adresses IP et noms de domaines spécifiques à Polytechnique.org (les enregistrements DNS étant publiques), ce qui facilite l'écriture des exemples.
  • La liste du matériel en place et ses caractéristiques techniques, qui n'ont pas d'intérêt à être partagés.

La documentation est écrite en français en utilisant l'encodage UTF-8.