Skip to content

[operations] docs(runbooks): add directory index for on-call navigation - #6780

Closed
hivecommons-hive[bot] wants to merge 1 commit into
mainfrom
operations/runbooks-index-6762
Closed

hivecommons-hive[bot] wants to merge 1 commit into
mainfrom
operations/runbooks-index-6762

Conversation

@hivecommons-hive

Copy link
Copy Markdown
Contributor

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 (root README.md, cluster-objects/prometheusrule.yaml runbook_url, .github/ISSUE_TEMPLATE/incident_postmortem.yaml, scripts/verify-site-health.sh).

Why

Fixes #6762. The root README.md already has an "Operational Readiness" section listing these runbooks (#6739, #6753), but that requires navigating back to repo root. GitHub auto-renders a directory's README.md when browsing it on github.com, so this gives on-call a fast index directly at runbooks/ — matching the failure page/alert experience of opening the linked runbook file straight into its directory.

Scope

Documentation-only, bounded to runbooks/*.md per 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

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>
@hivecommons-hive

Copy link
Copy Markdown
Contributor Author

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 approved-direction label — and remove the hold label here.

@kubestellar-prow

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kproche for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubestellar-prow kubestellar-prow Bot added the dco-signoff: yes Indicates the PR's author has signed the DCO. label Sep 7, 2026
@netlify

netlify Bot commented Sep 7, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for kubestellar-docs ready!

Name Link
🔨 Latest commit f38dd08
🔍 Latest deploy log https://app.netlify.com/projects/kubestellar-docs/deploys/6a9ea2f8e94f2d00082f4048
😎 Deploy Preview https://deploy-preview-6780--kubestellar-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@kubestellar-prow kubestellar-prow Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 7, 2026
@kubestellar-prow

Copy link
Copy Markdown

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions 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.

@github-actions github-actions Bot added copilot documentation Improvements or additions to documentation and removed copilot labels Sep 7, 2026
@hivecommons-hive

Copy link
Copy Markdown
Contributor Author

Closing as a stale duplicate. This PR and #6763 both add runbooks/README.md to fix the same finding (#6762), created a day apart. #6763 is the earlier, still-open, mergeable PR — consolidating on it to avoid two competing changes to the same file. Re-verified by operations during routine bead cleanup; no code or workflow changes were touched.

@hivecommons-hive hivecommons-hive Bot closed this Sep 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco-signoff: yes Indicates the PR's author has signed the DCO. documentation Improvements or additions to documentation hold needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[operations] runbooks/ has no index — during an incident, on-call has no fast way to find the right runbook

0 participants