Repository navigation
[AlertZero] Add glossary reference page - #8969
Merged
Merged
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
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. |
Contributor
🔍 Preview links for changed docs |
Contributor
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! 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. |
natasha-moore-elastic
marked this pull request as ready for review
October 22, 2026 13:38
bmorelli25
approved these changes
Oct 26, 2026
nastasha-solomon
added a commit
that referenced
this pull request
Oct 28, 2026
Aligns the variable set with the AlertZero glossary in #8969 so every term it defines has a variable with matching casing: autonomy, investigation, hunt finding, threat report, and threat intel supply. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Replaces AlertZero terms with the variables from #8715 so a rename updates the glossary automatically. The rendered text is unchanged. The frontmatter description, anchors, and the Attack Discovery feature name stay as literal text. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
|
Output lgtm! |
wajihaparvez
pushed a commit
to wajihaparvez/docs-content
that referenced
this pull request
Oct 28, 2026
## Summary Fixes elastic/docs-content-internal#1812 by making the following changes: * Adds 46 variables to `subs` in `docset.yml` for AlertZero's product name and the terms most likely to change before release. Pages use `{{alertzero}}` and the other variables, so a rename is a one-line change. * Covers every term the [AlertZero glossary](elastic#8969) defines, with the glossary's casing. | Group | Variables | | :---- | :---- | | Product | `alertzero` | | Watches and Workers | `az-watch`, `az-watches`, `az-worker`, `az-workers` | | Proposed actions | `az-proposed-action`, `az-proposed-actions`, `az-proposed-action-cap`, `az-proposed-actions-cap` | | Investigations | `az-investigation`, `az-investigations`, `az-investigation-cap`, `az-investigations-cap` | | Escalations | `az-escalation`, `az-escalations`, `az-escalation-cap`, `az-escalations-cap` | | Autonomy | `az-autonomy`, `az-autonomy-cap`, `az-manual`, `az-assisted`, `az-supervised` | | Watch names | `az-triage-watch`, `az-detection-watch`, `az-hunt-watch`, `az-forensics-watch` | | Worker names | `az-alert-triage`, `az-attack-discovery`, `az-continuous-threat-hunt`, `az-rule-tuning`, `az-rule-coverage`, `az-endpoint-analysis` | | Threat hunting | `az-hunt-finding`, `az-hunt-findings`, `az-hunt-finding-cap`, `az-hunt-findings-cap`, `az-threat-report`, `az-threat-reports`, `az-threat-report-cap`, `az-threat-reports-cap`, `az-threat-intel-supply`, `az-threat-intel-supply-cap` | | Model settings | `az-efficient-models`, `az-balanced-models`, `az-frontier-models`, `az-cyber-domain-models` | The `az-` prefix groups the variables and avoids clashes with general terms, such as `watcher`. Capitalization follows the style guide: proper nouns and product names are capitalized, everything else is lowercase, and casing matches the UI. Proposed action, investigation, and escalation are common nouns, lowercase mid-sentence as in the UI, so they get `-cap` variants for the start of a sentence, following existing pairs like `cps` and `cps-cap`. A comment in `docset.yml` notes that if they become proper nouns, all three change together, along with the UI. Terms that are always capitalized don't need `-cap` variants: Watch and Worker, plus the names of autonomy levels, individual Watches and Workers, and model settings. Merge this before elastic#8969 so the glossary can switch to these variables. Still open: the docs use "proposed action," matching the glossary, but the Kibana UI labels them **Proposals** on the autonomy level cards. ### Preview This PR changes only `docset.yml`, so there's no page to preview. Variable names and casing were checked against the glossary in elastic#8969 and the UI labels in Kibana `main`. A full `docs-builder` build has 0 errors and 0 warnings. ## Generative AI disclosure 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? * Yes - Claude Opus 5.5, via Claude Code --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: natasha-moore-elastic <natasha.moore@elastic.co> Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
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.
Contributes to https://github.com/elastic/docs-content-internal/issues/1817
Adds the AlertZero glossary reference page, which defines the terms used across AlertZero documentation and links each term to the page that explains it. It replaces the existing placeholder.
Note
This PR should use the variables defined in #8715 once 8715 is merged.
Made with Cursor