[Alerting V2][Serverless & 9.5][M2] Apply naming guidelines to Kibana alerting pages#6526
Conversation
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. |
🔍 Preview links for changed docs⏳ Building and deploying preview... View progress This comment will be updated with preview links when the build is complete. |
Elastic Docs Style Checker (Vale)Summary: 1 warning found
|
| 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>
35b27fc to
b00acf6
Compare
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
florent-leborgne
left a comment
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.mdpage correctly adds adescriptionfield. Four other changed files (alerting-getting-started.md,alerting-setup.md,create-manage-rules.md,view-alerts.md) are missingdescriptionfields, 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
descriptionfield inalerts.mdcorrectly 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.mdappropriately references the cross-reference that will be uncommented after PR #6521 merges. - The
docset.ymladditions foralerting-v2andalerting-v2-capsubstitution variables are correctly formatted.
Generated by Docs review agent for issue #6526 · ● 724.7K
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 featuresalerting-getting-started.md: rename H1 to "Getting started with Kibana alerting", update first sentencealerting-setup.md: rename H1 to "Set up Kibana alerting", add anchor sentencecreate-manage-rules.md: rename H1 to include "Kibana alerting"view-alerts.md: rename H1 to include "Kibana alerting", update intro sentenceWhy: 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
alerts.mdtokibana-alerting-experimental.mdis correct (resolves once PR [Alerting V2][Serverless & 9.5][M2] Add experimental alerting features overview pages #6521 is merged)🤖 Generated with Claude Code