Skip to content

[Alerting V2][Serverless & 9.5][M2] Apply naming guidelines to Kibana alerting pages#6526

Merged
nastasha-solomon merged 7 commits into
mainfrom
alerting/kibana-alerting-naming
May 28, 2026
Merged

[Alerting V2][Serverless & 9.5][M2] Apply naming guidelines to Kibana alerting pages#6526
nastasha-solomon merged 7 commits into
mainfrom
alerting/kibana-alerting-naming

Conversation

@nastasha-solomon

@nastasha-solomon nastasha-solomon commented May 15, 2026

Copy link
Copy Markdown
Member

Summary

Contributes to https://github.com/elastic/docs-content-internal/issues/919.

Updates five existing Kibana alerting pages in alerting/alerts/ to consistently use "Kibana alerting" as the primary term, per the alerting naming guidelines:

  • alerts.md: rename H1 to "Kibana alerting", add opening paragraph establishing the system identity, add cross-reference to experimental alerting features
  • alerting-getting-started.md: rename H1 to "Getting started with Kibana alerting", update first sentence
  • alerting-setup.md: rename H1 to "Set up Kibana alerting", add anchor sentence
  • create-manage-rules.md: rename H1 to include "Kibana alerting"
  • view-alerts.md: rename H1 to include "Kibana alerting", update intro sentence

Why: The naming guidelines establish "Kibana alerting" as the primary term for the existing alerting system to distinguish it from the experimental alerting features. Every page should identify its system in the first paragraph so search engines and AI retrieval can surface the right content.

This PR is independent and can be merged on its own. It is part of the broader series replacing PR #5528.

Test plan

🤖 Generated with Claude Code

@nastasha-solomon nastasha-solomon requested review from a team as code owners May 15, 2026 20:07
@github-actions

github-actions Bot commented May 15, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check 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.

@nastasha-solomon nastasha-solomon marked this pull request as draft May 15, 2026 20:17
@github-actions

github-actions Bot commented May 15, 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 May 15, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 1 warning found

⚠️ Warnings (1): Fix when the suggestion improves clarity or correctness.
File Line Rule Message
explore-analyze/alerting/watcher/enable-watcher.md 24 Elastic.MenuArrows Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy.

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.

Updates five existing pages to consistently use 'Kibana alerting' as the
primary term and add anchor sentences identifying the system:
- alerts.md: rename H1, add opening paragraph, add cross-reference to experimental features
- alerting-getting-started.md: rename H1, update first sentence
- alerting-setup.md: rename H1, add anchor sentence
- create-manage-rules.md: rename H1 to include 'Kibana alerting'
- view-alerts.md: rename H1 to include 'Kibana alerting', update intro

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@nastasha-solomon nastasha-solomon self-assigned this May 15, 2026
@nastasha-solomon nastasha-solomon changed the title Apply naming guidelines to Kibana alerting pages [Alerting V2][Serverless & 9.5][M2] Apply naming guidelines to Kibana alerting pages May 18, 2026
@nastasha-solomon nastasha-solomon marked this pull request as ready for review May 27, 2026 02:26
@nastasha-solomon nastasha-solomon requested a review from a team as a code owner May 27, 2026 02:26

@florent-leborgne florent-leborgne 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.

Surprised that kibana is added as explicit term if the feature is for serverless too (where that term is more or less hidden)

Should probably use {{kib}} when possible, but not a big deal either as it's part of a larger feature name

@nastasha-solomon nastasha-solomon merged commit 47dfc27 into main May 28, 2026
8 checks passed
@nastasha-solomon nastasha-solomon deleted the alerting/kibana-alerting-naming branch May 28, 2026 14:55

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Docs review summary

Focus areas

  • Style and clarity: Changes read well and follow Elastic style guidelines. The consistent use of "Kibana alerting" as the primary term improves clarity and searchability.
  • Jargon: No new jargon introduced. The term "Kibana alerting" is appropriately used to distinguish from experimental alerting features.
  • Frontmatter and applies_to: The alerts.md page correctly adds a description field. Four other changed files (alerting-getting-started.md, alerting-setup.md, create-manage-rules.md, view-alerts.md) are missing description fields, but this is pre-existing and outside the scope of this PR's changes.
  • Content type fit: Changes maintain appropriate content type structure (overviews and how-tos).
  • Parent issue satisfaction: Satisfied. The PR successfully applies the naming guidelines by consistently using "Kibana alerting" as the primary term across all five pages, adds system identification in first paragraphs, and avoids "Kibana alerting v1" terminology.

Notes

  • The newly added description field in alerts.md correctly uses literal "Kibana" rather than the {{kib}} substitution variable, per the frontmatter rule that descriptions should be plain text without substitution variables.
  • The TODO comment in alerts.md appropriately references the cross-reference that will be uncommented after PR #6521 merges.
  • The docset.yml additions for alerting-v2 and alerting-v2-cap substitution variables are correctly formatted.

Generated by Docs review agent for issue #6526 · ● 724.7K

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.

2 participants