Skip to content

Commit 41a65a4

Browse files
florent-leborgnemdbirnstiehlkilfoyle
authored
Replace leftover asciidoc lifecycle markers with applies_to (elastic#3143)
Reviewers, this PR: - replaces the existing markers with what seems to be the most appropriate equivalent applies_to - removes a couple of markers that didn't feel appropriate or felt too granular Please check that the changes for the areas you own are correct, or suggest edits where appropriate. Note: some of those look really old, they may not be necessary anymore. If you know about it, suggest to remove the applies_to. Tip: <img width="516" height="299" alt="image" src="https://github.com/user-attachments/assets/5db29499-a9ea-4c89-bd65-c37587c54aea" /> Part of: elastic#2951 --------- Co-authored-by: Mike Birnstiehl <[email protected]> Co-authored-by: David Kilfoyle <[email protected]>
1 parent 1b62630 commit 41a65a4

File tree

24 files changed

+125
-103
lines changed

24 files changed

+125
-103
lines changed

explore-analyze/alerts-cases/alerts/alerting-common-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Configuration options are available to specialize connections to TLS servers, in
6060
Rules are taking a long time to run and are impacting the overall health of your deployment.
6161

6262
::::{important}
63-
By default, only users with a `superuser` role can query the [preview] {{kib}} event log because it is a system index. To enable additional users to run this query, assign `read` privileges to the `.kibana-event-log*` index.
63+
By default, only users with a `superuser` role can query the {{kib}} event log because it is a system index. To enable additional users to run this query, assign `read` privileges to the `.kibana-event-log*` index.
6464

6565
::::
6666

explore-analyze/alerts-cases/alerts/alerting-troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ curl -X POST -k \
6262
-d '{"params":{"subject":"hallo","message":"hallo!","to":["[email protected]"]}}'
6363
```
6464

65-
[preview] In addition, there is a command-line client that uses legacy rule APIs, which can be easier to use, but must be updated for the new APIs. CLI tools to list, create, edit, and delete alerts (rules) and actions (connectors) are available in [kbn-action](https://github.com/pmuellr/kbn-action), which you can install as follows:
65+
{applies_to}`stack: preview` {applies_to}`serverless: preview` In addition, there is a command-line client that uses legacy rule APIs, which can be easier to use, but must be updated for the new APIs. CLI tools to list, create, edit, and delete alerts (rules) and actions (connectors) are available in [kbn-action](https://github.com/pmuellr/kbn-action), which you can install as follows:
6666

6767
```txt
6868
npm install -g pmuellr/kbn-action

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ You can add one or more actions to your rule to generate notifications when its
6161

6262
Each action uses a connector, which provides connection information for a {{kib}} service or third party integration, depending on where you want to send the notifications.
6363

64-
[preview] Some connectors that perform actions within {{kib}}, such as the [Cases connector](kibana://reference/connectors-kibana/cases-action-type.md), require less configuration. For example, you do not need to set the action frequency or variables.
64+
{applies_to}`stack: preview` {applies_to}`serverless: preview` Some connectors that perform actions within {{kib}}, such as the [Cases connector](kibana://reference/connectors-kibana/cases-action-type.md), require less configuration. For example, you do not need to set the action frequency or variables.
6565

6666
After you select a connector, set the action frequency. You can choose to create a summary of alerts on each check interval or on a custom interval. Alternatively, you an choose to run actions for each alert (at each check interval, only when the alert status changes, or at a custom interval).
6767

@@ -129,7 +129,7 @@ When you snooze a rule, the rule checks continue to run on a schedule but alerts
129129

130130
When a rule is in a snoozed state, you can cancel or change the duration of this state.
131131

132-
[preview] To temporarily suppress notifications for rules, you can also create a [maintenance window](maintenance-windows.md).
132+
{applies_to}`stack: preview` {applies_to}`serverless: preview` To temporarily suppress notifications for rules, you can also create a [maintenance window](maintenance-windows.md).
133133

134134
## View rule details [rule-details]
135135

explore-analyze/alerts-cases/alerts/rule-action-variables.md

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -68,23 +68,23 @@ If the rule’s action frequency is a summary of alerts, it passes the following
6868

6969
**Properties of the alerts.all.data objects**:
7070

71-
`kibana.alert.end`
72-
: Datetime stamp of alert end. [preview]
71+
`kibana.alert.end` {applies_to}`stack: preview` {applies_to}`serverless: preview`
72+
: Datetime stamp of alert end.
7373

74-
`kibana.alert.flapping`
75-
: A flag on the alert that indicates whether the alert status is changing repeatedly. [preview]
74+
`kibana.alert.flapping` {applies_to}`stack: preview` {applies_to}`serverless: preview`
75+
: A flag on the alert that indicates whether the alert status is changing repeatedly.
7676

77-
`kibana.alert.instance.id`
78-
: ID of the source that generates the alert. [preview]
77+
`kibana.alert.instance.id` {applies_to}`stack: preview` {applies_to}`serverless: preview`
78+
: ID of the source that generates the alert.
7979

80-
`kibana.alert.reason`
81-
: The reason of the alert (generated with the rule conditions). [preview]
80+
`kibana.alert.reason` {applies_to}`stack: preview` {applies_to}`serverless: preview`
81+
: The reason of the alert (generated with the rule conditions).
8282

83-
`kibana.alert.start`
84-
: Datetime stamp of alert start. [preview]
83+
`kibana.alert.start` {applies_to}`stack: preview` {applies_to}`serverless: preview`
84+
: Datetime stamp of alert start.
8585

86-
`kibana.alert.status`
87-
: Alert status (for example, active or OK). [preview]
86+
`kibana.alert.status` {applies_to}`stack: preview` {applies_to}`serverless: preview`
87+
: Alert status (for example, active or OK).
8888

8989
`alerts.new.count`
9090
: The count of new alerts.
@@ -94,23 +94,23 @@ If the rule’s action frequency is a summary of alerts, it passes the following
9494

9595
**Properties of the alerts.new.data objects**:
9696

97-
`kibana.alert.end`
98-
: Datetime stamp of alert end. [preview]
97+
`kibana.alert.end` {applies_to}`stack: preview` {applies_to}`serverless: preview`
98+
: Datetime stamp of alert end.
9999

100-
`kibana.alert.flapping`
101-
: A flag on the alert that indicates whether the alert status is changing repeatedly. [preview]
100+
`kibana.alert.flapping` {applies_to}`stack: preview` {applies_to}`serverless: preview`
101+
: A flag on the alert that indicates whether the alert status is changing repeatedly.
102102

103-
`kibana.alert.instance.id`
104-
: ID of the source that generates the alert. [preview]
103+
`kibana.alert.instance.id` {applies_to}`stack: preview` {applies_to}`serverless: preview`
104+
: ID of the source that generates the alert.
105105

106-
`kibana.alert.reason`
107-
: The reason of the alert (generated with the rule conditions). [preview]
106+
`kibana.alert.reason` {applies_to}`stack: preview` {applies_to}`serverless: preview`
107+
: The reason of the alert (generated with the rule conditions).
108108

109-
`kibana.alert.start`
110-
: Datetime stamp of alert start. [preview]
109+
`kibana.alert.start` {applies_to}`stack: preview` {applies_to}`serverless: preview`
110+
: Datetime stamp of alert start.
111111

112-
`kibana.alert.status`
113-
: Alert status (for example, active or OK). [preview]
112+
`kibana.alert.status` {applies_to}`stack: preview` {applies_to}`serverless: preview`
113+
: Alert status (for example, active or OK).
114114

115115
`alerts.ongoing.count`
116116
: The count of ongoing alerts.
@@ -120,23 +120,23 @@ If the rule’s action frequency is a summary of alerts, it passes the following
120120

121121
**Properties of the alerts.ongoing.data objects**:
122122

123-
`kibana.alert.end`
124-
: Datetime stamp of alert end. [preview]
123+
`kibana.alert.end` {applies_to}`stack: preview` {applies_to}`serverless: preview`
124+
: Datetime stamp of alert end.
125125

126-
`kibana.alert.flapping`
127-
: A flag on the alert that indicates whether the alert status is changing repeatedly. [preview]
126+
`kibana.alert.flapping` {applies_to}`stack: preview` {applies_to}`serverless: preview`
127+
: A flag on the alert that indicates whether the alert status is changing repeatedly.
128128

129-
`kibana.alert.instance.id`
130-
: ID of the source that generates the alert. [preview]
129+
`kibana.alert.instance.id` {applies_to}`stack: preview` {applies_to}`serverless: preview`
130+
: ID of the source that generates the alert.
131131

132-
`kibana.alert.reason`
133-
: The reason of the alert (generated with the rule conditions). [preview]
132+
`kibana.alert.reason` {applies_to}`stack: preview` {applies_to}`serverless: preview`
133+
: The reason of the alert (generated with the rule conditions).
134134

135-
`kibana.alert.start`
136-
: Datetime stamp of alert start. [preview]
135+
`kibana.alert.start` {applies_to}`stack: preview` {applies_to}`serverless: preview`
136+
: Datetime stamp of alert start.
137137

138-
`kibana.alert.status`
139-
: Alert status (for example, active or OK). [preview]
138+
`kibana.alert.status` {applies_to}`stack: preview` {applies_to}`serverless: preview`
139+
: Alert status (for example, active or OK).
140140

141141
`alerts.recovered.count`
142142
: The count of recovered alerts.
@@ -146,23 +146,23 @@ If the rule’s action frequency is a summary of alerts, it passes the following
146146

147147
**Properties of the alerts.recovered.data objects**:
148148

149-
`kibana.alert.end`
150-
: Datetime stamp of alert end. [preview]
149+
`kibana.alert.end` {applies_to}`stack: preview` {applies_to}`serverless: preview`
150+
: Datetime stamp of alert end.
151151

152-
`kibana.alert.flapping`
153-
: A flag on the alert that indicates whether the alert status is changing repeatedly. [preview]
152+
`kibana.alert.flapping` {applies_to}`stack: preview` {applies_to}`serverless: preview`
153+
: A flag on the alert that indicates whether the alert status is changing repeatedly.
154154

155-
`kibana.alert.instance.id`
156-
: ID of the source that generates the alert. [preview]
155+
`kibana.alert.instance.id` {applies_to}`stack: preview` {applies_to}`serverless: preview`
156+
: ID of the source that generates the alert.
157157

158-
`kibana.alert.reason`
159-
: The reason of the alert (generated with the rule conditions). [preview]
158+
`kibana.alert.reason` {applies_to}`stack: preview` {applies_to}`serverless: preview`
159+
: The reason of the alert (generated with the rule conditions).
160160

161-
`kibana.alert.start`
162-
: Datetime stamp of alert start. [preview]
161+
`kibana.alert.start` {applies_to}`stack: preview` {applies_to}`serverless: preview`
162+
: Datetime stamp of alert start.
163163

164-
`kibana.alert.status`
165-
: Alert status (for example, active or OK). [preview]
164+
`kibana.alert.status` {applies_to}`stack: preview` {applies_to}`serverless: preview`
165+
: Alert status (for example, active or OK).
166166

167167
### Action frequency: For each alert [alert-action-variables]
168168

explore-analyze/alerts-cases/alerts/rule-types.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Some rule types are subscription features, while others are free features. For a
2525
| --- | --- |
2626
| [{{es}} query](rule-type-es-query.md) | Run a user-configured {{es}} query, compare the number of matches to a configured threshold, and schedule actions to run when the threshold condition is met. |
2727
| [Index threshold](rule-type-index-threshold.md) | Aggregate field values from documents using {{es}} queries, compare them to threshold values, and schedule actions to run when the thresholds are met. |
28-
| [{{transform-cap}} rules](../../transforms/transform-alerts.md) | [beta] Run scheduled checks on a {{ctransform}} to check its health. If a {{ctransform}} meets the conditions, an alert is created and the associated action is triggered. |
28+
| [{{transform-cap}} rules](../../transforms/transform-alerts.md) | {applies_to}`stack: beta` {applies_to}`serverless: beta` Run scheduled checks on a {{ctransform}} to check its health. If a {{ctransform}} meets the conditions, an alert is created and the associated action is triggered. |
2929
| [Tracking containment](geo-alerting.md) | Run an {{es}} query to determine if any documents are currently contained in any boundaries from a specified boundary index and generate alerts when a rule’s conditions are met. |
3030

3131
## {{observability}} rules [observability-rules]
@@ -38,8 +38,12 @@ If you create a rule in the {{observability}} app, its alerts are not visible in
3838
::::
3939

4040
## Machine learning rules [ml-rules]
41+
```{applies_to}
42+
stack: beta
43+
serverless: beta
44+
```
4145

42-
[beta] [{{ml-cap}} rules](../../machine-learning/anomaly-detection/ml-configuring-alerts.md) run scheduled checks on an {{anomaly-job}} to detect anomalies with certain conditions. If an anomaly meets the conditions, an alert is created and the associated action is triggered.
46+
[{{ml-cap}} rules](../../machine-learning/anomaly-detection/ml-configuring-alerts.md) run scheduled checks on an {{anomaly-job}} to detect anomalies with certain conditions. If an anomaly meets the conditions, an alert is created and the associated action is triggered.
4347

4448
## Security rules [security-rules]
4549

explore-analyze/alerts-cases/alerts/testing-connectors.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,11 @@ or by directly opening the proper connector edit flyout:
2929
:screenshot:
3030
:::
3131

32-
## [preview] Troubleshooting connectors with the `kbn-action` tool [_troubleshooting_connectors_with_the_kbn_action_tool]
32+
## Troubleshooting connectors with the `kbn-action` tool [_troubleshooting_connectors_with_the_kbn_action_tool]
33+
```{applies_to}
34+
stack: preview
35+
serverless: preview
36+
```
3337

3438
You can run an email action via [kbn-action](https://github.com/pmuellr/kbn-action). In this example, it is a Cloud hosted deployment of the {{stack}}:
3539

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ products:
1313

1414
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).
1515

16-
You can manage the alerts for each rule in **{{stack-manage-app}}** > **{{rules-ui}}**. Alternatively, manage all your alerts in **{{stack-manage-app}}** > **Alerts**. [preview]
16+
You can manage the alerts for each rule in **{{stack-manage-app}}** > **{{rules-ui}}**. Alternatively, manage all your alerts in **{{stack-manage-app}}** > **Alerts**.
1717

1818
:::{image} /explore-analyze/images/kibana-stack-management-alerts-page.png
1919
:alt: Alerts page with multiple alerts

explore-analyze/alerts-cases/cases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ products:
1313

1414
Cases are used to open and track issues directly in {{kib}}. You can add assignees and tags to your cases, set their severity and status, and add alerts, comments, and visualizations. You can create cases automatically when alerts occur or send cases to external incident management systems by configuring connectors.
1515

16-
You can also optionally add custom fields and case templates. [preview]
16+
{applies_to}`stack: preview` {applies_to}`serverless: preview` You can also optionally add custom fields and case templates.
1717

1818
:::{image} /explore-analyze/images/kibana-cases-list.png
1919
:alt: Cases page

explore-analyze/alerts-cases/cases/manage-cases.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Open a new case to keep track of issues and share their details with colleagues.
2323
:screenshot:
2424
:::
2525

26-
2. If you defined [templates](manage-cases-settings.md#case-templates), you can optionally select one to use its default field values. [preview]
26+
2. If you defined [templates](manage-cases-settings.md#case-templates), you can optionally select one to use its default field values.
2727
3. Give the case a name, severity, and description.
2828
::::{tip}
2929
In the `Description` area, you can use [Markdown](https://www.markdownguide.org/cheat-sheet) syntax to create formatted text.
@@ -32,14 +32,10 @@ Open a new case to keep track of issues and share their details with colleagues.
3232
4. Optionally, add a category, assignees, and tags. You can add users only if they meet the necessary [prerequisites](setup-cases.md).
3333
5. If you defined any [custom fields](manage-cases-settings.md#case-custom-fields), they appear in the **Additional fields** section.
3434

35-
:::{admonition} Added in 8.15.0
36-
This functionality was added in 8.15.0.
37-
:::
38-
3935
6. For the **External incident management system**, select a connector. For more information, refer to [External incident management systems](manage-cases-settings.md#case-connectors).
4036
7. After you’ve completed all of the required fields, click **Create case**.
4137

42-
[preview] Alternatively, you can configure your rules to automatically create cases by using [case actions](kibana://reference/connectors-kibana/cases-action-type.md). By default, the rule adds all of the alerts within a specified time window to a single case. You can optionally choose a field to group the alerts and create separate cases for each group. You can also choose whether you want the rule to reopen cases or open new ones when the time window elapses.
38+
{applies_to}`stack: preview` {applies_to}`serverless: preview` Alternatively, you can configure your rules to automatically create cases by using [case actions](kibana://reference/connectors-kibana/cases-action-type.md). By default, the rule adds all of the alerts within a specified time window to a single case. You can optionally choose a field to group the alerts and create separate cases for each group. You can also choose whether you want the rule to reopen cases or open new ones when the time window elapses.
4339

4440
## Add email notifications [add-case-notifications]
4541

explore-analyze/machine-learning/nlp/ml-nlp-elser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ELSER is an out-of-domain model which means it does not require fine-tuning on y
1818
This model is recommended for English language documents and queries. If you want to perform semantic search on non-English language documents, use the [E5](ml-nlp-e5.md) model.
1919

2020
::::{important}
21-
While ELSER V2 is generally available, ELSER V1 is in [preview] and will remain in technical preview.
21+
While ELSER V2 is generally available, ELSER V1 is and will remain in technical preview.
2222
::::
2323

2424
## Tokens - not synonyms [elser-tokens]

0 commit comments

Comments
 (0)