Skip to content

Cut docs to decisions, move procedures to runbooks, prune comments - #123

Merged
yama6a merged 5 commits into
mainfrom
clean-up-prose-and-comments
Sep 26, 2026
Merged

yama6a merged 5 commits into
mainfrom
clean-up-prose-and-comments

Conversation

@yama6a

@yama6a yama6a commented Sep 26, 2026 •

Copy link
Copy Markdown
Owner

Brings every doc, comment, alert text and operator message in line with the repo's writing rules, and cuts what does not matter.

  • Decision docs in docs/ now hold only decisions and architecture. Procedures moved to docs/runbooks/, one per area. Mechanism detail lives in code comments.
  • Stale facts are fixed, such as step numbers, alert names and the kubeconfig path.

Rendered manifests change only in comments and messages. Four ConfigMap checksums change, so Grafana, ntfy, orphan-exporter and dead-node-watcher each restart once on the first sync.

@yama6a yama6a changed the title Rewrite docs and comments in plain short sentences Cut docs to decisions, move procedures to runbooks, prune comments Sep 26, 2026
@yama6a
yama6a merged commit 4b079a6 into main Sep 26, 2026
5 checks passed
@yama6a
yama6a deleted the clean-up-prose-and-comments branch September 26, 2026 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant