Skip to content

[AlertZero] Add variables for AlertZero terms - #8715

Open
nastasha-solomon wants to merge 6 commits into
mainfrom
nsolomon/alertzero-variables
Open

nastasha-solomon wants to merge 6 commits into
mainfrom
nsolomon/alertzero-variables

Conversation

@nastasha-solomon

Copy link
Copy Markdown
Member

Summary

Fixes https://github.com/elastic/docs-content-internal/issues/1812.

This PR adds variables for AlertZero's product name and the terms most likely to change before release. Pages then use {{alertzero}} and the other variables, so a rename is a one-line change in docset.yml.

What changes

Adds 21 variables to subs in docset.yml:

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
Escalations az-escalation, az-escalations, az-escalation-cap, az-escalations-cap
Autonomy levels az-manual, az-assisted, az-supervised
Watch names az-triage-watch, az-detection-watch, az-hunt-watch, az-forensics-watch
Worker names az-endpoint-analysis

Naming: The az- prefix groups the variables and avoids clashes with general terms, such as watcher. Lowercase terms get -cap variants, following existing pairs like cps and cps-cap. Watch and Worker are always capitalized, so they don't need -cap variants.

For review

The first three points are also comments in docset.yml, so they stay visible after this PR merges.

  • Proposed action or Proposal? The product glossary calls it a Proposal, but the docs outline uses "proposed action." Which should the docs use?
  • Autonomy level names aren't final. That's why they're variables.
  • Only one Worker name is included. Endpoint Analysis is locked. Other Worker names vary across sources, such as Rule coverage and Rule Creation, so add them once they're locked.
  • No variable for "thread," because it isn't an MVP concept.

Verification

  • Full docs-builder build: 0 errors and 0 warnings. One hint lists the new variables as unused, which is expected until pages use them.

This PR doesn't depend on #8651. Merge it before any AlertZero page PR opens, so page previews show the right terms.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. Tool(s) and model(s) used: Claude Code (Claude Opus 5.5).

nastasha-solomon and others added 2 commits October 6, 2026 19:40
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@nastasha-solomon nastasha-solomon self-assigned this Oct 6, 2026
@github-actions

github-actions Bot commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

⏳ Building and deploying preview... View progress

This comment will be updated with preview links when the build is complete.

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
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.

yetanothertw pushed a commit to stefnestor/docs-content that referenced this pull request Oct 12, 2026
## Summary

Fixes elastic/docs-content-internal#1811.

This PR adds the AlertZero docs as hidden stub pages, so each page can
be drafted in its own PR from `main`. It follows revision 5 of the
AlertZero docs structure, tracked in
elastic/docs-content-internal#1472.

**Stacked on elastic#8651.** AlertZero goes in the navigation that elastic#8651
creates: between Manage and AI-assisted operations, with its privileges
page under Access control. Retarget this PR to `main` after elastic#8651
merges.

### What changes

- **19 hidden pages** in `solutions/security/alertzero/`. Each has a
title, a description, and one sentence on what it covers. Every file
sits directly in that folder, with no subfolders, so moving a page in
the navigation never changes its URL.
- **Navigation:** Every page has a `hidden` entry in
`solutions/toc.yml`. AlertZero comes after Manage and before AI-assisted
operations. AlertZero privileges sits under Manage → Access control,
next to Attack Discovery privileges.
- **Anchors for planned links:** Configure Worker settings has an
autonomy section, and Watches and Workers has a section for each Watch.
Other pages can link to these anchors before they're drafted.

### Not in this PR

- **Page content.** Each page is drafted in its own PR, branched from
`main` after this one merges.
- **Variables.** They're in elastic#8715. The stubs use plain text, so this PR
doesn't depend on that one.
- **Kibana settings reference entries** for the AlertZero advanced
setting.

### For review

- **Lifecycle:** Every page uses `stack: preview 9.6` and `serverless:
security: preview` as placeholders. Is AlertZero technical preview,
beta, or GA in 9.6, and when does it reach serverless?

### Verification

- Full `docs-builder` build: 0 errors and 0 warnings. The 4 new hints
are the same kind existing pages get: a parent page with children ("uses
deep-linking with children").
- All 19 pages build, and none of them appear in the navigation.

## Previews

Stacked PRs don't generate previews, so previews appear after this PR is
retargeted to `main`. Hidden pages don't appear in the preview's
navigation. Open them directly, starting from the landing page:

-
https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/8716/solutions/security/alertzero

## Generative AI disclosure

1. Did you use a generative AI (GenAI) tool to assist in creating this
contribution?
- [x] Yes
- [ ] No

2. Tool(s) and model(s) used: Claude Code (Claude Opus 5.5).

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
@natasha-moore-elastic
natasha-moore-elastic marked this pull request as ready for review October 22, 2026 12:22
@natasha-moore-elastic
natasha-moore-elastic requested a review from a team as a code owner October 22, 2026 12:22

This branch was successfully deployed

1 active deployment
docs-preview — a4bfd637 Deployed Oct 28, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants