From 1824a1885dca7b7722634d4ba2d83a8996971029 Mon Sep 17 00:00:00 2001 From: Gabriel Radureau Date: Tue, 23 Jun 2026 23:42:24 +0200 Subject: [PATCH] docs(vibe): add maintenance rule to the ansible + opentofu sub-hubs The two factory-provisioning sub-hubs were the only guidebook index pages without the "alter a documented component -> update its page in the same PR" reminder that every sibling hub carries. Add a scoped maintenance rule to each, pointing back to the factory-provisioning maintenance rule and the guidebooks' Rules to contribute, so no folder hub silently drifts. Co-Authored-By: Claude Opus 4.8 --- vibe/guidebooks/factory-provisioning/ansible/README.md | 7 +++++++ vibe/guidebooks/factory-provisioning/opentofu/README.md | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/vibe/guidebooks/factory-provisioning/ansible/README.md b/vibe/guidebooks/factory-provisioning/ansible/README.md index f5dd516..9ec705c 100644 --- a/vibe/guidebooks/factory-provisioning/ansible/README.md +++ b/vibe/guidebooks/factory-provisioning/ansible/README.md @@ -118,3 +118,10 @@ flowchart LR | 06 | [Recover](06-recover.md) | Longhorn + data restore (on-demand DR branch) | 🟑 | | β€” | [Inventory & variables](inventory.md) | `hosts.yml` groups, `group_vars/` layering, hostβ†’service mapping | βœ… | | β€” | [Roles reference](roles.md) | The seven `arcodange.factory.*` roles | βœ… | + +--- + +## Maintenance rule + +> [!IMPORTANT] +> **Alter a playbook, role, inventory entry, or `group_vars` β†’ update the matching page here in the same change.** Adding a stage, renaming a role, bumping the K3s version or a `requirements.yml` dependency, or moving a host between groups all change what the pages above describe β€” edit the page in the PR that changes the code, never as a follow-up. This is the [factory-provisioning maintenance rule](../README.md#maintenance-rule) applied to the Ansible half; the guidebooks' full [Rules to contribute](../../README.md#rules-to-contribute) also apply. diff --git a/vibe/guidebooks/factory-provisioning/opentofu/README.md b/vibe/guidebooks/factory-provisioning/opentofu/README.md index 9362cd6..b7c08f7 100644 --- a/vibe/guidebooks/factory-provisioning/opentofu/README.md +++ b/vibe/guidebooks/factory-provisioning/opentofu/README.md @@ -93,3 +93,10 @@ flowchart TD | [factory iac](factory-iac.md) | `iac/` root β€” Gitea, Vault, Google/GCS backup, Cloudflare, OVH | βœ… | | [postgres iac](postgres-iac.md) | `postgres/iac/` root β€” PostgreSQL roles & databases on pi2 | βœ… | | [CI apply flow](ci-apply-flow.md) | Both Gitea workflows, the Vault-JWT exchange, auto-approve apply | βœ… | + +--- + +## Maintenance rule + +> [!IMPORTANT] +> **Alter a `.tf` resource, a provider version, a state backend, or a CI workflow β†’ update the matching page here in the same change.** Adding a resource to `iac/`, changing the `postgres/iac/` application list, bumping a provider pin, or editing `iac.yaml`/`postgres.yaml` all change what the pages above describe β€” edit the page in the PR that changes the code, never as a follow-up. This is the [factory-provisioning maintenance rule](../README.md#maintenance-rule) applied to the OpenTofu half; the guidebooks' full [Rules to contribute](../../README.md#rules-to-contribute) also apply.