Factory > Doc
Documentation Factory
Last Updated: 2026-05-31 Status: Production · maintenue activement Related: README racine du dépôt · Collection Ansible
arcodange.factory
C'est quoi ?
Le dossier doc/ rassemble la documentation de la plateforme Arcodange (k3s + Gitea + ArgoCD + OpenTofu + Vault + Postgres, auto-hébergée sur 3 Raspberry Pi). On y trouve deux familles :
- les ADR (records de décisions d'architecture), qui expliquent pourquoi la plateforme est faite ainsi ;
- les runbooks, qui expliquent comment exécuter une procédure opérationnelle de bout en bout.
Note
Convention du dépôt (cf. PR #8) : la documentation vit sous
doc/(singulier). Un ancien dossierdocs/(pluriel) a pu traîner non-suivi par git — ne pas y ajouter de contenu.
Sections
| Section | Ce qu'on y trouve | Statut |
|---|---|---|
| Runbooks | Procédures opérationnelles pas-à-pas (créer une app, etc.) | ✅ |
| ADR | Décisions d'architecture + checklist de mise en place de la plateforme | ✅ |
Légende de statut
✅ actif · 🟡 dégradé/beta · 🔴 critique/EOL · ⚠️ problème connu · ❌ désactivé
Comment éditer cette documentation
- Ajouter une page → la créer depuis le template adéquat et ajouter sa ligne dans la table d'index du
README.mdparent. - Supprimer une page → la marquer Décommissionnée (date) d'abord ; supprimer le fichier et sa ligne d'index ensemble une fois qu'elle est vraiment partie.
- Garder les liens croisés bidirectionnels → quand on lie A→B, ajouter B→A.
- Mettre à jour
Last Updated:en tête de la racine concernée après tout changement de structure.