Repository navigation
[operations] docs(runbooks): add directory index for on-call navigation - #6780
hivecommons-hive[bot] wants to merge 1 commit into
Conversation
Add runbooks/README.md summarizing scope and inbound links for all 6 existing runbooks (slo, deploy-rollback, version-branch-rollback, scorecard-monitoring, stale-workflow-monitoring, api-error-rate-latency). GitHub renders this automatically when browsing the runbooks/ directory, giving on-call a fast way to pick the right runbook without first going back to the root README or opening each file to read its H1. Fixes #6762 Signed-off-by: KubeStellar Operations Agent <operations-agent@kubestellar-hive.local>
|
Important Held for human sign-off on the direction, not on the code. This PR's only tracked rationale is #6762, which the hive filed itself — issue #6762 was filed by kubestellar-hive[bot] and no human has acknowledged it. An agent-filed issue does not, on its own, establish that anyone agreed to the direction (hivecommons/hive#5117). The change may well be right; nothing here is a review of it. To release the hold, acknowledge the direction on that issue — comment on it, assign yourself, or add the |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for kubestellar-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Hi @kubestellar-hive[bot]. Thanks for your PR. I'm waiting for a kubestellar member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
Closing as a stale duplicate. This PR and #6763 both add |
What
Adds
runbooks/README.md: a table indexing all 6 existing runbooks (slo.md,deploy-rollback.md,version-branch-rollback.md,scorecard-monitoring.md,stale-workflow-monitoring.md,api-error-rate-latency.md) with a one-line scope and where each is currently linked from (rootREADME.md,cluster-objects/prometheusrule.yamlrunbook_url,.github/ISSUE_TEMPLATE/incident_postmortem.yaml,scripts/verify-site-health.sh).Why
Fixes #6762. The root
README.mdalready has an "Operational Readiness" section listing these runbooks (#6739, #6753), but that requires navigating back to repo root. GitHub auto-renders a directory'sREADME.mdwhen browsing it on github.com, so this gives on-call a fast index directly atrunbooks/— matching the failure page/alert experience of opening the linked runbook file straight into its directory.Scope
Documentation-only, bounded to
runbooks/*.mdper operations policy: one new file, no workflow, alert, or code changes. No existing alert or SLO was touched or weakened.Filed and implemented per operations policy (ACMM L6, full mode). Not merging this PR myself.
— hive: agent=operations backend=copilot model=claude-sonnet-4-6