Files

T

Kantin-Petit c096fa9467 docs: conventions versioning + doc + paliers de risque (v0.2.0)

Pose les règles non négociables : SemVer + un-artefact-un-commit, pinning
des images, export JSON des workflows n8n ; gabarit de doc d'asset ;
paliers réversible/privilégié avec invariant anti-escalade ; schéma
d'architecture et invariants d'exposition. Ignore settings.local.json.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

2026-06-23 00:59:25 +02:00

1.4 KiB

Raw Permalink Blame History

Gabarit de doc d'asset

Copier ce gabarit pour chaque artefact créé par/pour CHLOVA (workflow n8n, stack Portainer, outil, image). Un asset non documenté est incomplet. Fichier suggéré : docs/assets/<type>-<slug>.md.

<Nom de l'asset>

Type : workflow-n8n | stack-portainer | tool | image | service
Version : vX.Y.Z
Palier de risque : reversible | privileged (voir risk-tiers.md)
Statut (need-review) : provisoire | approuvé | refusé | bloqué | n/a
Lien commit : <sha ou URL>
Créé le : YYYY-MM-DD · Expire le : YYYY-MM-DD (si provisoire)

Rôle

Ce que fait l'asset, en une à trois phrases. Pourquoi il existe.

Entrées / sorties

Entrées : paramètres, déclencheurs, données consommées.
Sorties : effets, données produites, notifications émises.

Dépendances

Services (Ollama, n8n, Portainer…), autres assets, variables d'env (par référence, jamais de valeur), réseau.

Sécurité

Secrets manipulés (par référence) ; pourquoi le palier de risque est celui-ci ; surface d'exposition (doit rester interne).

Rollback

Comment annuler : commande/étapes précises pour revenir à l'état antérieur (ex. redeploy de la version N-1, désactivation du workflow, git revert <sha>).
Effets de bord à nettoyer.

Tests / vérification

Comment vérifier que l'asset fonctionne et reste read-only si applicable.

1.4 KiB Raw Permalink Blame History