[Security][Quality] Add conceptual documentation for detection alerts#5387
Draft
nastasha-solomon wants to merge 2 commits intomainfrom
Draft
[Security][Quality] Add conceptual documentation for detection alerts#5387nastasha-solomon wants to merge 2 commits intomainfrom
nastasha-solomon wants to merge 2 commits intomainfrom
Conversation
Contributor
Vale Linting ResultsSummary: 2 warnings, 2 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| solutions/security/detect-and-alert/alert-storage-and-schema.md | 72 | Elastic.DontUse | Don't use 'just'. |
| solutions/security/detect-and-alert/detection-alert-concepts.md | 35 | Elastic.Spelling | 'Triaged' is a possible misspelling. |
💡 Suggestions (2)
| File | Line | Rule | Message |
|---|---|---|---|
| solutions/security/detect-and-alert/alert-storage-and-schema.md | 35 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| solutions/security/detect-and-alert/alert-storage-and-schema.md | 91 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
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.
Contributor
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes https://github.com/elastic/docs-content-internal/issues/837 by adding new conceptual documentation for detection alerts, addressing a gap where users and support lacked a clear explanation of what detection alerts are, how they work under the hood, and what is and isn't supported when filtering and searching them.
New pages
detection-alert-concepts.md) — Hub page covering what a detection alert is, the alert lifecycle (created → triaged → resolved), and a detailed breakdown of supported filtering/searching capabilities and known limitations.alert-storage-and-schema.md) — Where alerts are stored (index aliases, backing indices, retention/rollover), how index mappings are composed from three component templates (ECS, technical, Security), and the keykibana.alert.*fields in an alert document.how-alerts-are-generated.md) — The 7-step alert generation pipeline,max_signalslimits, preview alerts, and alert types (regular, building block, suppressed).detection-vs-external-alerts.md) — Side-by-side comparison of detection alerts (event.kind: "signal") and external alerts (event.kind: "alert"), plus how they relate (external alerts as inputs, detection alerts as outputs).Note: Add these pages to the "Before you begin" section or the docs about managing alerts
Key details covered
These were previously undocumented or hard to find:
Generative AI disclosure
Claude + Cursor