Skip to content

docs: shorten alert text and move the detail to the monitoring page - #387

Merged
cplieger merged 1 commit into
mainfrom
docs/alert-text
Oct 5, 2026
Merged

cplieger merged 1 commit into
mainfrom
docs/alert-text

Conversation

@cplieger

@cplieger cplieger commented Oct 5, 2026

Copy link
Copy Markdown
Owner

Summary

  • Shortens every shipped alert rule's text so a notification reads at a glance: summaries of 12 words or fewer, descriptions of 40 words or fewer, and a short file header.
  • Moves the longer explanations, citations, version notes and severity reasoning to the Alerting section of docs/monitoring.md, so nothing is lost.
  • No rule expression, duration, severity or name changes.

Testing

  • A measurement script checks every limit; the YAML parses and markdownlint passes.
  • The tests that read the alert files pass.
  • A second review checked that no fact was dropped and that every message stays true to its rule.

@cplieger
cplieger merged commit f714bb5 into main Oct 5, 2026
19 checks passed
@cplieger
cplieger deleted the docs/alert-text branch October 5, 2026 13:56
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