Files
factory/doc
arcodangeandClaude Opus 4.8 47a1b1222f docs(ci): référence la page 6b dans l'index du runbook new-web-app
Ajoute la ligne 06b (CI des apps Bun/Nuxt) à l'index des étapes et bump
Last Updated, conformément à la règle « Comment éditer ce runbook ».

Co-Authored-By: Claude Opus 4.8 <[email protected]>
2026-07-12 13:37:18 +02:00
..

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 dossier docs/ (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

  1. Ajouter une page → la créer depuis le template adéquat et ajouter sa ligne dans la table d'index du README.md parent.
  2. 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.
  3. Garder les liens croisés bidirectionnels → quand on lie A→B, ajouter B→A.
  4. Mettre à jour Last Updated: en tête de la racine concernée après tout changement de structure.