From 518abac9f492fc82d9461f6e3326e047f149ffe7 Mon Sep 17 00:00:00 2001 From: Erich Blume Date: Mon, 16 Feb 2026 17:02:01 -0800 Subject: [PATCH] Move service-versions.yaml to repo root and add cross-references Quartz may not handle YAML files in docs/, so move the tracking file to the repo root. Add version tracking checklist items to deploy-k8s-service, add-ansible-role, and adding-a-service guides. Co-Authored-By: Claude Opus 4.6 --- docs/how-to/add-ansible-role.md | 9 +++++++++ docs/how-to/deploy-k8s-service.md | 1 + docs/how-to/knowledgebase/review-services.md | 4 ++-- docs/tutorials/adding-a-service.md | 1 + mise-tasks/service-review | 2 +- .../service-versions.yaml => service-versions.yaml | 0 6 files changed, 14 insertions(+), 3 deletions(-) rename docs/reference/services/service-versions.yaml => service-versions.yaml (100%) diff --git a/docs/how-to/add-ansible-role.md b/docs/how-to/add-ansible-role.md index a7c2ded..5c51a79 100644 --- a/docs/how-to/add-ansible-role.md +++ b/docs/how-to/add-ansible-role.md @@ -136,8 +136,17 @@ For metrics collection, create a companion `_metrics` role that: See [[alloy]] for how metrics are collected from textfiles. +## Checklist + +- [ ] Role created in `ansible/roles//` +- [ ] Role added to `ansible/playbooks/indri.yml` with tag +- [ ] Secrets wired via pre_tasks (if needed) +- [ ] Dry run passes: `mise run provision-indri -- --tags --check --diff` +- [ ] Service added to `service-versions.yaml` for version tracking + ## Related - [[ansible]] - Available roles reference - [[indri]] - Target host - [[observability]] - Metrics collection +- [[review-services]] - Periodic service version review diff --git a/docs/how-to/deploy-k8s-service.md b/docs/how-to/deploy-k8s-service.md index e54fd7a..6005d6f 100644 --- a/docs/how-to/deploy-k8s-service.md +++ b/docs/how-to/deploy-k8s-service.md @@ -131,6 +131,7 @@ argocd app sync - [ ] Tested on feature branch - [ ] PR reviewed and merged - [ ] Reset to main branch +- [ ] Service added to `service-versions.yaml` for version tracking ## Related diff --git a/docs/how-to/knowledgebase/review-services.md b/docs/how-to/knowledgebase/review-services.md index a029b84..4716bbf 100644 --- a/docs/how-to/knowledgebase/review-services.md +++ b/docs/how-to/knowledgebase/review-services.md @@ -19,7 +19,7 @@ Show services sorted by when they were last reviewed (most stale first): mise run service-review ``` -This reads the tracking file at `docs/reference/services/service-versions.yaml` and sorts by the `last-reviewed` field. Services without a review date float to the top. The script shows a staleness table and then displays the most stale service with a review checklist. +This reads the tracking file at `service-versions.yaml` (repo root) and sorts by the `last-reviewed` field. Services without a review date float to the top. The script shows a staleness table and then displays the most stale service with a review checklist. To show more entries in the table: @@ -64,7 +64,7 @@ Same as ArgoCD, but also check for new chart versions in the mirrored chart repo ## Marking a Service as Reviewed -After reviewing, edit `docs/reference/services/service-versions.yaml` and update the service entry: +After reviewing, edit `service-versions.yaml` (repo root) and update the service entry: ```yaml - name: prometheus diff --git a/docs/tutorials/adding-a-service.md b/docs/tutorials/adding-a-service.md index 3f9b7a4..5fdce11 100644 --- a/docs/tutorials/adding-a-service.md +++ b/docs/tutorials/adding-a-service.md @@ -246,6 +246,7 @@ See [[grafana]] for dashboard provisioning details. - [ ] Metrics/dashboard configured (if applicable) - [ ] PR created and reviewed - [ ] Reset to main after merge +- [ ] Service added to `service-versions.yaml` for version tracking ## Related diff --git a/mise-tasks/service-review b/mise-tasks/service-review index e1f1246..03b9b4a 100755 --- a/mise-tasks/service-review +++ b/mise-tasks/service-review @@ -30,7 +30,7 @@ from rich.console import Console from rich.panel import Panel from rich.table import Table -VERSIONS_FILE = Path(__file__).parent.parent / "docs" / "reference" / "services" / "service-versions.yaml" +VERSIONS_FILE = Path(__file__).parent.parent / "service-versions.yaml" def load_services(path: Path) -> list[dict]: diff --git a/docs/reference/services/service-versions.yaml b/service-versions.yaml similarity index 100% rename from docs/reference/services/service-versions.yaml rename to service-versions.yaml