Skip to content

Commit 47dfc27

Browse files
[Alerting V2][Serverless & 9.5][M2] Apply naming guidelines to Kibana alerting pages (#6526)
## Summary Contributes to elastic/docs-content-internal#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](#5528). ## Test plan - [ ] Confirm no "Kibana alerting v1" in modified files - [ ] Verify the cross-reference in `alerts.md` to `kibana-alerting-experimental.md` is correct (resolves once PR #6521 is merged) - [ ] Check H1 changes don't break any existing anchor links (H1 anchors not changed) 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 36fdd50 commit 47dfc27

7 files changed

Lines changed: 19 additions & 11 deletions

File tree

docset.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ subs:
124124
ls-pipelines-app: "Logstash Pipelines"
125125
maint-windows-app: "Maintenance Windows"
126126
maint-windows-cap: "Maintenance windows"
127+
alerting-v2: "experimental alerting features"
128+
alerting-v2-cap: "Experimental alerting features"
127129
custom-roles-app: "Custom Roles"
128130
data-source: "data view"
129131
data-sources: "data views"

explore-analyze/alerting/alerts.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,15 @@ products:
1010
- id: kibana
1111
- id: cloud-serverless
1212
- id: cloud-hosted
13+
description: "Overview of Kibana alerting: rules, alerts, actions, connectors, and how they work together."
1314
---
1415

15-
# Alerts
16+
# {{kib}} alerting [alerts]
17+
18+
{{kib}} alerting is the built-in alerting system in {{kib}}. It lets you define rules that check your data on a schedule, create alerts when conditions are met, and trigger actions through connectors (email, Slack, webhooks, and more). It is available on all deployments.
19+
<!-- TODO: Uncomment when PR #6521 (experimental overview) is merged:
20+
For the {{alerting-v2}} built on {{esql}}, refer to [{{alerting-v2-cap}}](kibana-alerting-experimental.md).
21+
-->
1622

1723
## {{rules-ui}} [rules]
1824

explore-analyze/alerting/alerts/alerting-getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ products:
1414
- id: elastic-stack
1515
---
1616

17-
# Getting started with alerting [alerting-getting-started]
17+
# Getting started with {{kib}} alerting [alerting-getting-started]
1818

19-
Alerting enables you to define *rules*, which detect complex conditions within different {{kib}} apps and trigger actions when those conditions are met. Alerting is integrated with [**{{observability}}**](../../../solutions/observability/incident-management/alerting.md), [**Security**](detection-rules://index.md), [**Maps**](geo-alerting.md) and [**{{ml-app}}**](../../../explore-analyze/machine-learning/anomaly-detection/ml-configuring-alerts.md). It can be centrally managed from **{{stack-manage-app}}** and provides a set of built-in [connectors](../../../deploy-manage/manage-connectors.md) and [rules](rule-types.md#stack-rules) for you to use.
19+
{{kib}} alerting is the built-in alerting system in {{kib}}. It enables you to define *rules*, which detect complex conditions within different {{kib}} apps and trigger actions when those conditions are met. Alerting is integrated with [**{{observability}}**](../../../solutions/observability/incident-management/alerting.md), [**Security**](detection-rules://index.md), [**Maps**](geo-alerting.md) and [**{{ml-app}}**](../../../explore-analyze/machine-learning/anomaly-detection/ml-configuring-alerts.md). It can be centrally managed from **{{stack-manage-app}}** and provides a set of built-in [connectors](../../../deploy-manage/manage-connectors.md) and [rules](rule-types.md#stack-rules) for you to use.
2020

2121
:::{image} /explore-analyze/images/kibana-alerting-overview.png
2222
:alt: {{rules-ui}} UI

explore-analyze/alerting/alerts/alerting-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ products:
99
- id: kibana
1010
---
1111

12-
# Set up [alerting-setup]
12+
# Set up {{kib}} alerting [alerting-setup]
1313

14-
{{kib}} {{alert-features}} are automatically enabled, but might require some additional configuration.
14+
{{kib}} alerting is the built-in alerting system in {{kib}}. {{alert-features}} are automatically enabled, but might require some additional configuration.
1515

1616
## Prerequisites [alerting-prerequisites]
1717

explore-analyze/alerting/alerts/create-manage-rules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ products:
99
- id: kibana
1010
---
1111

12-
# Create and manage alerting rules with {{kib}} [create-and-manage-rules]
12+
# Create and manage {{kib}} alerting rules [create-and-manage-rules]
1313

14-
The **{{stack-manage-app}}** > **{{rules-ui}}** UI provides a cross-app view of alerting. Different {{kib}} apps like [**{{observability}}**](../../../solutions/observability/incident-management/alerting.md), [**Security**](detection-rules://index.md), [**Maps**](geo-alerting.md) and [**{{ml-app}}**](../../machine-learning/machine-learning-in-kibana.md) can offer their own rules.
14+
The **{{stack-manage-app}}** > **{{rules-ui}}** UI provides a cross-app view of {{kib}} alerting. Different {{kib}} apps like [**{{observability}}**](../../../solutions/observability/incident-management/alerting.md), [**Security**](detection-rules://index.md), [**Maps**](geo-alerting.md) and [**{{ml-app}}**](../../machine-learning/machine-learning-in-kibana.md) can offer their own rules.
1515

1616
You can find **Rules** in **Stack Management** > **Alerts and insights** > **Rules** in {{kib}} or by using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
1717

explore-analyze/alerting/alerts/view-alerts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ products:
99
- id: kibana
1010
---
1111

12-
# View and manage alerts in {{kib}} [view-alerts]
12+
# View and manage alerts from {{kib}} alerting rules [view-alerts]
1313

14-
When the conditions of a rule are met, it creates an alert. If the rule has actions, they run at the defined frequency. For example, the rule can send email notifications for each alert at a custom interval. For an introduction to the concepts of rules, alerts, and actions, refer to [Alerting](../alerts.md).
14+
{{kib}} alerting creates an alert when the conditions of a rule are met. If the rule has actions, they run at the defined frequency. For example, the rule can send email notifications for each alert at a custom interval. For an introduction to the concepts of rules, alerts, and actions, refer to [{{kib}} alerting](../alerts.md).
1515

1616
Manage alerts from the following places:
1717

explore-analyze/alerting/watcher/enable-watcher.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ products:
1010
# Enable Watcher [enable-watcher]
1111

1212
::::{note}
13-
If you are looking for Kibana alerting, check [Alerting](../../../explore-analyze/alerting.md).
13+
If you are looking for {{kib}} alerting, check [Alerting](../../../explore-analyze/alerting.md).
1414
::::
1515

1616
Watcher can be enabled when configuring your cluster. You can run Alerting on a separate cluster from the cluster whose data you are actually watching.
@@ -23,7 +23,7 @@ To enable Watcher on a cluster, you may first need to perform one or several of
2323

2424
* To receive default Elasticsearch Watcher alerts (cluster status, nodes changed, version mismatch), you need to have monitoring enabled to send to the Admin email address specified in Kibana. To enable this, go to **Advanced Settings > Admin email**.
2525

26-
To learn more about Kibana alerting and how to use it, check [Alerting and Actions](../../../explore-analyze/alerting.md).
26+
To learn more about {{kib}} alerting and how to use it, check [Alerting and Actions](../../../explore-analyze/alerting.md).
2727

2828
## Send alerts by email [watcher-allowlist]
2929

0 commit comments

Comments
 (0)