[Alerting V2][Serverless & 9.5][M2] Add experimental alerting features overview pages#6521
[Alerting V2][Serverless & 9.5][M2] Add experimental alerting features overview pages#6521nastasha-solomon wants to merge 19 commits into
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
🔍 Preview links for changed docs |
Elastic Docs Style Checker (Vale)Summary: 1 warning found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/alerting/kibana-alerting-experimental.md | 120 | Elastic.Spelling | 'cooldown' is a possible misspelling. |
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.
- alerting.md: updated section overview for all three alerting systems - alerting/choose-an-alerting-system.md: new comparison and selection guide - alerting/kibana-alerting-experimental.md: new experimental alerting features overview with concepts glossary and Dispatcher entry - explore-analyze/images/rule-alert-mode-diagram.png, rule-detect-mode-diagram.png: new diagrams - toc.yml: navigation entries for new pages Applies naming guidelines throughout. Cross-references to pages in later PRs are commented out with TODO notes. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
5e76dfb to
ff31898
Compare
…6521 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…fter PR #6521 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…lastic/docs-content into alerting/experimental-overview
… alerting pages (#6526) ## Summary Contributes to elastic/docs-content-internal#919. Updates five existing Kibana alerting pages in `alerting/alerts/` to consistently use "Kibana alerting" as the primary term, per the alerting naming guidelines: - `alerts.md`: rename H1 to "Kibana alerting", add opening paragraph establishing the system identity, add cross-reference to experimental alerting features - `alerting-getting-started.md`: rename H1 to "Getting started with Kibana alerting", update first sentence - `alerting-setup.md`: rename H1 to "Set up Kibana alerting", add anchor sentence - `create-manage-rules.md`: rename H1 to include "Kibana alerting" - `view-alerts.md`: rename H1 to include "Kibana alerting", update intro sentence **Why**: The naming guidelines establish "Kibana alerting" as the primary term for the existing alerting system to distinguish it from the experimental alerting features. Every page should identify its system in the first paragraph so search engines and AI retrieval can surface the right content. This PR is independent and can be merged on its own. It is part of the broader series replacing [PR #5528](#5528). ## Test plan - [ ] Confirm no "Kibana alerting v1" in modified files - [ ] Verify the cross-reference in `alerts.md` to `kibana-alerting-experimental.md` is correct (resolves once PR #6521 is merged) - [ ] Check H1 changes don't break any existing anchor links (H1 anchors not changed) 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
|
A few suggestions for your consideration: 1/ The landing page could be simplified : 2/ To make content more actionable, consider using the "stepper" feature in the various sections under Kibana alerting (Getting started with alerts, Set up, Create and manage rules, View and manage alerts, Query alert indices) 3/ On the explore-analyze/alerting.md there seems to be a mismatch across H2
|
alaudazzi
left a comment
There was a problem hiding this comment.
Nice work! I left a few suggestions, mainly related to the overall structure and navigation.
Shall we also reconsider the quantity of admonitions? On the View and manage alerts from Kibana alerting rules page there are 3 Notes, 3 Tips, 1 Important, and 1 Warning.
alexandra5000
left a comment
There was a problem hiding this comment.
I'm not really familiar with alerting, but I left some comments anyway 😎 Take them or leave them!
The one I feel is maybe the most important is the one regarding the "core idea" section, which should be easily understandable even for a person with little to no prior knowledge on the subject. You may not see it as confusing because of your familiarity with the subject matter.
| | **Rule definition** | Select a rule type and fill in parameters | Write an {{esql}} query | Write a JSON watch definition | | ||
| | **Alert data** | In-place updates; limited query support | Append-only events queryable with {{esql}} in Discover | Watch history index | | ||
| | **Notifications** | Configured per action on each rule | Centralized action policies, reusable across rules | Action-level throttling and conditions | | ||
| | **Noise reduction** | Snooze per rule, maintenance windows | Per-episode acknowledge or deactivate; per-series snooze; maintenance windows; match condition routing in action policies | Action conditions and throttling | |
There was a problem hiding this comment.
| | **Noise reduction** | Snooze per rule, maintenance windows | Per-episode acknowledge or deactivate; per-series snooze; maintenance windows; match condition routing in action policies | Action conditions and throttling | | |
| | **Noise reduction** | Snooze per rule, maintenance windows | Per-episode acknowledge or deactivate; per-series snooze; maintenance windows; match condition routing in action policies. Refer to [{{alerting-v2-system-cap}} overview](kibana-alerting-experimental.md) for more information | Action conditions and throttling | |
I know you're aware of it being rather jargon-y and hard to understand "at a glance", I also get why you wouldn't want to clutter the table, but maybe a link here wouldn't hurt? But if you feel the target reader/user will know what that's about, then it may not be necessary after all.

Summary
Contributes to https://github.com/elastic/docs-content-internal/issues/919. This PR contains content that introduces the alerting v2 system.
Review requests
This PR needs a technical and editorial review. Instructions for each are below.
🔧 Technical reviewer
Please focus your review on accuracy of facts, names, and structure only. For example, please verify that field names, values, and descriptions in reference material are accurate and match the current implementation. When reviewing conceptual material, please check that definitions are technically accurate and reflect the current engineering design.
✏️ Editorial reviewer
This PR adds three pages that introduce the alerting v2 system alongside the existing Elastic alerting options: an overview of the experimental alerting system with a key concepts glossary, a comparison and selection guide across all three Elastic alerting systems, and an overview (
alerting.md) that frames all three systems for readers arriving at the section root.Please focus on writing quality, clarity, and how the content serves a reader who is seeing this system for the first time.
🚫 What to skip for now
Do not flag or review the following. I'll be fixing them after EAH:
[CONTENT NEEDED]is intentionally incomplete pending UI finalization or technical confirmation.rule-alert-mode-diagram.pngand rule-detect-mode-diagram.png images are outdated or don't align with the examples.Terminology
Clarity and reader framing
kibana-alerting-experimental.md: The "core idea" section frames the motivation as avoiding the need to edit every rule when notification routing changes. Does this land clearly for a first-time reader, or does it read more like an internal architectural concern than a user benefit?choose-an-alerting-system.md: The Noise reduction row in "Compare at a glance" uses terms that require prior knowledge of the system (per-episode acknowledge or deactivate, per-series snooze, match condition routing in action policies). Check whether a reader who arrives at this page without reading the overview can make sense of this row, or whether it will only land for readers who already know the system.explore-analyze/alerting/kibana-alerting-experimental.mdexplore-analyze/alerting/choose-an-alerting-system.mdexplore-analyze/alerting.md🤖 Generated with Claude Code