docs: describe Alertmanager architecture - #5390
Conversation
Signed-off-by: Dean Chen <51218137+locker95@users.noreply.github.com>
📝 WalkthroughWalkthroughREADME.md and ChangesAlertmanager documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Hi @locker95 , This is the kind description that tends to go stale over time. I think it is probably better to have a link pointing towards architecture documentation, and put the description there (if it adds something). Kind regards |
Signed-off-by: Dean Chen <51218137+locker95@users.noreply.github.com>
|
Thanks @SoloJacobs, addressed in bf55531. The README now keeps only a short, stable summary and links to the architecture overview in |
Summary
Keep a short, stable summary and documentation link below the architecture diagram. Add an architecture overview to
docs/alertmanager.mdcovering the alert flow, while linking to the existing high-availability documentation for cluster-specific behavior.This keeps implementation details out of the README so they are less likely to become stale.
cc @simonpasquier
Pull Request Checklist
Validation
git diff --checkdocs/alertmanager.md#architecturedocs/high_availability.mdWhich user-facing changes does this PR introduce?