Commit 74d1716
authored
## Summary
Comprehensive edits to the experimental alerting system get-started
documentation. Addresses two internal tracking issues
([#1419](elastic/docs-content-internal#1419) —
implicit Elasticsearch privilege grant for the Alerts privilege, and
[#1420](elastic/docs-content-internal#1420) —
setup prerequisites), and applies structural, editorial, and clarity
improvements across all four pages in the section.
---
## Content changes
### `get-started.md`
Updated the landing page intro and all three child page descriptions to
accurately reflect the current content of each page. Updated the
frontmatter description.
---
### `get-started/setup.md`
- Added a **Requirements** section covering license requirements
(Enterprise required for Workflows-based notifications on Stack; no
restriction on Serverless), data prerequisites, connectors, and space
selection.
- Moved the `configure-access.md` cross-reference earlier in the page
(after the "Confirm the UI is accessible" step) rather than only in Next
steps.
- Simplified the "Turn on the system" tab-set by removing the
`**Requirement:**` / `**Steps:**` heading pattern and inlining the role
requirement.
- Updated frontmatter description to reflect the page's actual scope
(requirements + on/off mechanics).
---
### `get-started/configure-access.md`
Addresses
[#1419](elastic/docs-content-internal#1419):
- **Quick Reference table**: Split the single "Query rule and episode
data in Discover" row into two rows — one for
`.rule-events`/`.alert-actions` (access bundled with the Alerts
privilege) and one for `.kibana-event-log-*` (still requires a custom
role).
- **Triage alerts section**: Added a note that granting **Alerts: All**
or **Alerts: Read** automatically includes Elasticsearch `read` access
to `.rule-events` and `.alert-actions`, with no separate index privilege
needed.
- **ES index access section**: Rewrote to clarify the access method per
data source. `.rule-events` and `.alert-actions` access is bundled with
the Alerts privilege; `.kibana-event-log-*` still requires a custom
role. Custom-role fallback preserved for the two auto-granted streams.
- Added **Next steps** section with a link to the tutorial and
commented-out links for notifications and rules content pending PRs
#6523 and #6525.
---
### `get-started/create-your-first-rule.md`
**Structure:**
- Separated environment setup (index creation, sample data) from the
rule creation workflow into a dedicated **Prepare your environment**
section with its own stepper.
- Split the single "Create the rule" stepper step into five focused
steps: Open the rule editor, Write and test the detection query,
Configure the alert condition, Configure the recovery condition, and
Name and save the rule.
- Moved "Confirm the rule is evaluating" and "Observe the episode
lifecycle" out of the Tutorial stepper and into standalone `##`
sections, since they're observational steps after rule creation, not
part of the creation workflow itself.
**Content:**
- Rewrote the page intro to be high-level and inviting, with a numbered
task list that previews each section and explains its purpose.
- Added a intro paragraph to "Prepare your environment", "Create the
rule", and "Observe the episode lifecycle" to orient users before the
steps begin.
- Added brief explanations for the detection query (what `PERCENTILE`,
`CASE`, and `WHERE` do) and the lifecycle query (what `STATS ... BY`
produces), for readers new to ES|QL.
- Simplified time-phase descriptions (removed redundant minute-count
approximations; standardized on clock times).
- Shortened and simplified the timestamp update note.
- Improved sandbox recovery preview explanation — framed as a preview of
recovery behavior rather than a "verification step."
- Fixed step numbering bug in "Observe the episode lifecycle" (step `3`
was mislabeled).
**Requirements section** (addresses
[#1420](elastic/docs-content-internal#1420)):
- Replaced the manual `read` index privilege on `.rule-events` with
**Alerts: Read**, noting that this automatically grants Elasticsearch
access with no separate index privilege needed.
- Added **Discover: Read** as an explicit requirement.
- Added `create_index` and `write` index privileges on
`checkout-service-logs`.
- Reformatted requirements as a table (Task / Required privilege) for
scannability.
**Editorial:**
- Removed all em dashes throughout.
- Replaced `"via"` with `"using"`.
- Replaced bold-header prose blocks with properly structured lists and
tables.
---
## Out of scope
- Rules reference docs (PR #6523)
- Action policies and notifications docs (PR #6525)
- Alerts/Discover query docs (PR #6527)
- ECH-specific setup behavior for the `xpack.alerting_v2.enabled` flag
(pending engineering confirmation; placeholder comment left in
`setup.md`)
---
## Generative AI disclosure
- Yes — Cursor + Claude
1 parent 533118d commit 74d1716
4 files changed
Lines changed: 172 additions & 100 deletions
File tree
- explore-analyze/alerting/kibana-alerting-experimental
- get-started
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
17 | | - | |
18 | | - | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
Lines changed: 23 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
| 32 | + | |
| 33 | + | |
33 | 34 | | |
34 | 35 | | |
35 | 36 | | |
| |||
66 | 67 | | |
67 | 68 | | |
68 | 69 | | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
69 | 74 | | |
70 | 75 | | |
71 | 76 | | |
| |||
109 | 114 | | |
110 | 115 | | |
111 | 116 | | |
112 | | - | |
| 117 | + | |
113 | 118 | | |
114 | | - | |
| 119 | + | |
115 | 120 | | |
116 | | - | |
117 | | - | |
118 | | - | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
119 | 126 | | |
120 | | - | |
| 127 | + | |
121 | 128 | | |
122 | | - | |
123 | | - | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
124 | 137 | | |
| 138 | + | |
0 commit comments