Skip to content

[Alerting V2] Document 9.6 GA without version-split experimental content - #9019

Open
nastasha-solomon wants to merge 8 commits into
mainfrom
remove-experimental-content-av2
Open

nastasha-solomon wants to merge 8 commits into
mainfrom
remove-experimental-content-av2

Conversation

@nastasha-solomon

@nastasha-solomon nastasha-solomon commented Oct 23, 2026 •

Copy link
Copy Markdown
Member

Summary

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

The Alerting V2 docs now describe only the 9.6 GA version. The system was experimental for one minor (9.5) and changed a lot before GA, so this PR removes the 9.5 content instead of keeping it next to the GA content.

This PR doesn't document the breaking changes between 9.5 and 9.6. Experimental features have no compatibility promises, and the 9.5 release notes still cover the experimental release.

Changes

Version tags

  • Changes the page-level applies_to to stack: ga 9.6+ by dropping experimental =9.5. The related-page badges in alerting.md, alerts.md, compare-alerting-systems.md, and detect-and-alert.md get the same change.
  • Removes inline badges that only separated GA content from 9.5 content.
  • Tags the alert and rule lifecycle workflow triggers as preview 9.6+, to match their tech_preview registration in Kibana.
  • Changes the Agent Builder tags from experimental 9.5+ to experimental 9.6+.

Removed 9.5 content

  • Replaces each applies-switch block with only its GA content.
  • Removes 9.5-only fields, options, and UI paths: episode_id/episode_status, query.format, recovery_strategy, no_data_strategy, action policy tags, rule fields in Match conditions, the rule-form notification flow, and the Alerting V2 Preview navigation path.
  • Removes the 9.5 trigger IDs and event.episodeId from the workflow trigger pages.
  • Removes the 9.5 naming note for the Universal Alerting privilege from Configure access and Kibana privileges.

Page updates

  • Alerting V2 overview: Replaces the version box with one navigation sentence and adds an upgrade note for anyone who tried 9.5.
  • Set up:
    • Adds the same upgrade note.
    • Removes the turn-on steps, because the system is on by default.
    • Groups the three advanced settings in one section, with a table of each setting's scope and default.
    • Moves the turn-off steps to the end, under "Opt out of Universal Alerting".
    • Describes experimental features in general terms instead of listing each one.
  • Create your first rule:
    • Matches the steps to the GA rule form, checked against Kibana main.
    • Cuts the requirements to a deployment and the required privileges.
    • Points Serverless users to an Observability project, because Kibana hides Universal Alerting in Elasticsearch and Security projects.
  • Alerting and Compare alerting systems: Removes the fixed count of alerting systems, which depends on the deployment type and version.

Preview

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes - Claude Opus 5.5, via Cursor

Alerting V2 is GA on serverless and in 9.6, so the Alerting V2 pages now
describe only GA behavior. The page-level applies_to tag
(stack: ga 9.6+, experimental =9.5) is the only place 9.5 still appears,
which tells readers the system was experimental in 9.5.

Removes 9.5-only content: the 9.5 tabs in applies-switch blocks, the
episode_id and episode_status fields, query.format, metadata.owner,
artifacts[].value, recovery_strategy, no_data_strategy, the flat
state_transition.pending_* fields, action policy tags, rule fields in
Match conditions, the rule-form notification flow, and the Alerting V2
Preview navigation path. Removes the 9.5 upgrade warning for Match
conditions, since 9.5 breaking changes don't need documenting.

Removes redundant serverless: ga and stack: ga 9.6+ badges that only
contrasted GA content with 9.5.

Updates the workflow trigger pages to drop the 9.5 trigger IDs and
event.episodeId, and tags alert and rule lifecycle triggers as
preview 9.6+. Kibana registers them as tech_preview.

Updates the Universal Alerting row in Kibana privileges to drop the
9.5 naming note. Keeps the GA badges there because that page covers
all stack versions.

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions

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.

@github-actions

github-actions Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

More links …

@github-actions

github-actions Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 2 warnings, 1 suggestion found

⚠️ Warnings (2): Fix when the suggestion improves clarity or correctness.
File Line Rule Message
explore-analyze/workflows/triggers/event-driven-triggers.md 472 Elastic.Spelling 'unresolves' is a possible misspelling.
explore-analyze/workflows/triggers/event-driven-triggers.md 475 Elastic.Spelling 'unsnoozed' is a possible misspelling.
💡 Suggestions (1): Optional style improvements. Apply when helpful.
File Line Rule Message
explore-analyze/alerting/esql/get-started/create-your-first-rule.md 292 Elastic.Ellipses Use ellipses sparingly. Remove the ellipsis unless it appears in UI text.

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.

Goes fully GA-only, as proposed in elastic/docs-content-internal#2079.
Changes stack: ga 9.6+, experimental =9.5 to stack: ga 9.6+ in the
Alerting V2 page frontmatter and in the related-page badges
(alerting.md, alerts.md, compare-alerting-systems.md, and
detect-and-alert.md). Drops experimental =9.5 from the workflow
lifecycle trigger badges, and moves the Agent Builder tags from
experimental 9.5+ to experimental 9.6+.

Adds the upgrade note from the issue to the overview and setup pages.
The note tells anyone who tried the experimental version in 9.5 to
upgrade to 9.6. On the overview page, the note joins the existing
Classic Alerting note rather than stacking a second admonition.

Co-authored-by: Cursor <cursoragent@cursor.com>
@nastasha-solomon nastasha-solomon changed the title [Alerting V2] Remove 9.5 experimental content from the Alerting V2 docs [Alerting V2] Document 9.6 GA without version-split experimental content Oct 23, 2026
nastasha-solomon and others added 2 commits October 23, 2026 17:22
Checks the tutorial against Kibana main and updates it to match the GA
rule form:

- Removes the deployment-type requirement and the "turned on"
  requirement. Universal Alerting is on by default.
- Adds a serverless-only requirement for an Observability project,
  because Kibana hides Universal Alerting in Elasticsearch and Security
  projects.
- Opens the rule form through Create rule > ES|QL rule, and the sandbox
  through Add query.
- Splits configuration into the Condition step (schedule and lookback)
  and the Outcome step (goal, alert delay, and recovery). Removes the
  Mode field, which no longer exists.
- Searches for the rule in Execution history instead of selecting it,
  and names the Trend chart on the alert details page.

Co-authored-by: Cursor <cursoragent@cursor.com>
Condenses the requirements to two bullets: an Elastic Stack deployment
or an Observability project on Serverless, and the privileges needed
for the tutorial. Removes the inline serverless badge so the deployment
requirement covers both deployment types without version numbers.

Co-authored-by: Cursor <cursoragent@cursor.com>
…counts

Setup page:
- Removes the "Turn on the system" section. Universal Alerting is on by
  default.
- Groups the three advanced settings under one section with a summary
  table of scope and default.
- Renames the turn-off section to "Opt out of Universal Alerting", moves
  it to the end, and rewrites it as numbered steps with a short summary
  of what turning it off does and doesn't do.
- Describes experimental features in general terms instead of listing
  each one.
- Clarifies how the new Alerts page differs from the Classic-only
  Observability Alerts page, and names the setting that keeps it.
- Shortens the requirements and intro, and points Next steps only to
  the first-rule tutorial.

Other pages:
- Replaces "three alerting systems" on the alerting overview and the
  compare page with wording that doesn't depend on a fixed count.
- Updates the setup page summaries on the overview and how-it-works
  pages.

Co-authored-by: Cursor <cursoragent@cursor.com>

@bmorelli25 bmorelli25 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very clean 👍. One thing to fix.


## Requirements [create-rule-requirements]

Before you start, make sure you have the following:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I had to complain, I would complain that the changes in this file probably could've been in a separate PR 😛

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fair! I just wanted to get the tutorial changes in asap

Comment on lines 255 to +257
Go to **Alerting** → **Rules** in the {{observability}} navigation menu, or find **Rules** using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).

Then create a new rule, and select **Create ES|QL rule** to open the rule authoring flyout.
Select **Create rule**, then select **ES|QL rule** to open the rule form.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When there are no existing rules, the "Create rule" button doesn't show up on the page. Instead users go straight to clicking on ES | QL rule

Image

@shainaraskas shainaraskas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would we want to keep the experimental tag on the core feature so people know it was available but experimental then?

ok either way - just a thought

🏁 for the one admin docs file

This branch was successfully deployed

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants