Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contribute-docs/_snippets/applies_to-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@
Regardless of the version format used in the source file, the version number is always rendered in the `Major.Minor.Patch` format.

:::{note}
**Automatic Version Sorting**: When you specify multiple versions for the same product, the build system automatically sorts them in descending order (highest version first) regardless of the order you write them in the source file. For example, `stack: ga 8.18.6, ga 9.1.2, ga 8.19.2, ga 9.0.6` will be displayed as `stack: ga 9.1.2, ga 9.0.6, ga 8.19.2, ga 8.18.6`. Items without versions (like `ga` without a version or `all`) are sorted last.
**Automatic Version Sorting**: When you specify multiple versions for the same product, the build system automatically sorts them in descending order (highest version first) regardless of the order you write them in the source file. For example, `stack: preview =9.0, ga 9.1-9.7, deprecated =9.8, removed 9.9+` will be displayed as `stack: removed 9.9+, deprecated =9.8, ga 9.1-9.7, preview =9.0`. Items without versions (like `ga` without a version or `all`) are sorted last.
:::
10 changes: 7 additions & 3 deletions contribute-docs/how-to/cumulative-docs/example-scenarios.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ applies_to:
### Assign colors to terms [assign-colors-to-terms]

```{applies_to}
stack: ga 9.1, preview 9.0,
stack: ga 9.1+, preview =9.0,
serverless: ga
```

Expand Down Expand Up @@ -571,7 +571,11 @@ _Work in progress._

## Functionality is added to multiple patch versions [multiple-patch]

Sometimes, features and enhancements slip through into patch versions, and the same functionality might be added for the first time to multiple patch versions at the same time. In that case, use two `applies_to` badges so that users can see clearly the versions in which the functionality is introduced. Order the `applies_to` badges starting with the latest version, and ending with the earliest version. (Automatic ordering for multiple badges is not currently supported.)
Sometimes, features and enhancements slip through into patch versions, and the same functionality might be added for the first time to multiple patch versions at the same time.

- **Standard case**: Our docs are aligned with the latest patch of any given minor version. That means that in most cases, we don't need to call out the exact patch version that introduced a change (that's for the release notes).

- **Exceptions**: In rare cases, it can happen that the change is important enough to be explicitly called out in the docs with a precise patch-level information. In that case, use two `applies_to` badges with the `!` extra symbol so that users can see clearly the versions in which the functionality is introduced. Order the `applies_to` badges starting with the latest version, and ending with the earliest version. (Automatic ordering for multiple badges is not currently supported.)

For example, on the [HTTP JSON input](https://www.elastic.co/docs/reference/beats/filebeat/filebeat-input-httpjson) page, the `terminate` helper function was added to a 9.0.x and 9.1.x patch version at the same time.

Expand All @@ -586,7 +590,7 @@ For example, on the [HTTP JSON input](https://www.elastic.co/docs/reference/beat
```markdown
* `terminate`: exits the template without falling back to the default value
and without causing an error. It takes a single string argument that is
logged in debug logging. {applies_to}`stack: ga 9.1.2` {applies_to}`stack: ga 9.0.6`
logged in debug logging. {applies_to}`stack: ga 9.1.2+!` {applies_to}`stack: ga 9.0.6+!`
```
::::
:::::
2 changes: 1 addition & 1 deletion contribute-docs/how-to/cumulative-docs/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ This means that badges will always appear to users from newest to oldest, which

For example:

{applies_to}`stack: preview 9.0.5, beta 9.1, ga 9.2`
{applies_to}`stack: preview =9.0, beta =9.1, ga 9.2+`

### Keys

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,9 @@

The following file extensions are used for the approximate kNN search: Each extension is broken down by the quantization types.

* {applies_to}`stack: ga 9.3` `cenivf` for DiskBBQ to store centroids
* {applies_to}`stack: ga 9.3` `clivf` for DiskBBQ to store clusters of quantized vectors
* {applies_to}`stack: ga 9.3+` `cenivf` for DiskBBQ to store centroids
* {applies_to}`stack: ga 9.3+` `clivf` for DiskBBQ to store clusters of quantized vectors
* `vex` for the HNSW graph

Check notice on line 130 in deploy-manage/production-guidance/optimize-performance/approximate-knn-search.md

View workflow job for this annotation

GitHub Actions / preview / vale

Elastic.Acronyms: 'HNSW' has no definition.
* `vec` for all non-quantized vector values. This includes all element types: `float`, `byte`, and `bit`.
* `veq` for quantized vectors indexed with [`quantization`](elasticsearch://reference/elasticsearch/mapping-reference/dense-vector.md#dense-vector-quantization): `int4` or `int8`
* `veb` for binary vectors indexed with [`quantization`](elasticsearch://reference/elasticsearch/mapping-reference/dense-vector.md#dense-vector-quantization): `bbq`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ The following settings are supported:
`get_register_retry_delay`
: ([time value](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#time-units)) Sets the time to wait before trying again if an attempt to read a [linearizable register](#repository-s3-linearizable-registers) fails. Defaults to `5s`.

`unsafely_incompatible_with_s3_conditional_writes` {applies_to}`stack: ga 9.2.3`
`unsafely_incompatible_with_s3_conditional_writes` {applies_to}`stack: ga 9.2.3+!`
: (boolean) {{es}} uses AWS S3's support for conditional writes to protect against repository corruption. If your repository is based on a storage system which claims to be S3-compatible but does not accept conditional writes, set this setting to `true` to make {{es}} perform unconditional writes, bypassing the repository corruption protection, while you work with your storage supplier to address this incompatibility with AWS S3. Defaults to `false`.

::::{note}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ mapped_pages:
- https://www.elastic.co/guide/en/kibana/current/maintenance-windows.html
- https://www.elastic.co/guide/en/serverless/current/maintenance-windows.html
applies_to:
stack: preview 9.0, ga 9.2
stack: preview 9.0-9.1, ga 9.2+
serverless: ga
products:
- id: kibana
Expand Down
2 changes: 1 addition & 1 deletion explore-analyze/cross-cluster-search.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The following APIs support {{ccs}}:
* [Painless execute API](elasticsearch://reference/scripting-languages/painless/painless-api-examples.md)
* [Resolve Index API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index)
* [Vector tile search](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search-mvt)
* {applies_to}`stack: preview 9.0, ga 9.1` [ES|QL](elasticsearch://reference/query-languages/esql/esql-cross-clusters.md)
* {applies_to}`stack: preview =9.0, ga 9.1+` [ES|QL](elasticsearch://reference/query-languages/esql/esql-cross-clusters.md)
* {applies_to}`stack: preview` [EQL search](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-eql-search)
* {applies_to}`stack: preview` [SQL search](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-sql-query)

Expand Down
13 changes: 7 additions & 6 deletions explore-analyze/dashboards/add-controls.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ To add interactive Options list and Range slider controls, create the controls,
1. Open or create a new dashboard.
2. Add a control.

* {applies_to}`stack: ga 9.2` In **Edit** mode, select **Add** > **Controls** > **Control** in the toolbar.
* {applies_to}`stack: ga 9.0` In **Edit** mode, select **Controls** > **Add control** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` In **Edit** mode, select **Add** > **Controls** > **Control** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` In **Edit** mode, select **Controls** > **Add control** in the dashboard toolbar.

3. On the **Create control** flyout, from the **Data view** dropdown, select the data view that contains the field you want to use for the **Control**.
4. In the **Field** list, select the field you want to filter on.
Expand Down Expand Up @@ -93,8 +93,8 @@ You can add one interactive time slider control to a dashboard.
1. Open or create a new dashboard.
2. Add a time slider control.

* {applies_to}`stack: ga 9.2` In **Edit** mode, select **Add** > **Controls** > **Time slider control** in the toolbar.
* {applies_to}`stack: ga 9.0` In **Edit** mode, select **Controls** > **Add time slider control**.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` In **Edit** mode, select **Add** > **Controls** > **Time slider control** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` In **Edit** mode, select **Controls** > **Add time slider control**.

3. The time slider control uses the time range from the global time filter. To change the time range in the time slider control, [change the global time filter](../query-filter/filtering.md).
4. Save the dashboard. The control can now be used.
Expand All @@ -107,6 +107,7 @@ serverless: preview
```

:::{note}
:applies_to: stack: ga 9.0-9.1
In versions `9.0` and `9.1`, variable controls are called {{esql}} controls.
:::

Expand Down Expand Up @@ -159,8 +160,8 @@ Several settings apply to all controls that are part of a dashboard.

1. Configure the control settings.

* {applies_to}`stack: ga 9.2` In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar.
* {applies_to}`stack: ga 9.0` In **Edit** mode, select **Controls** > **Settings**.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` In **Edit** mode, select **Add** > **Controls** > **Settings** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` In **Edit** mode, select **Controls** > **Settings**.

2. On the **Control settings** flyout, configure the following settings:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Open the visualization editor, then make sure the correct fields appear.

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization**.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization**.

2. Make sure the **Kibana Sample Data eCommerce** {{data-source}} appears, then set the [time filter](../query-filter/filtering.md) to **Last 30 days**.

Expand Down Expand Up @@ -102,8 +102,8 @@ To analyze multiple series, create a line chart that displays the price distribu

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. Open the **Visualization type** dropdown, then select **Line**.
3. From the **Available fields** list, drag **products.price** to the workspace.
Expand Down Expand Up @@ -143,8 +143,8 @@ To analyze multiple visualization types, create an area chart that displays the

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. From the **Available fields** list, drag **products.price** to the workspace.
3. In the layer pane, click **Median of products.price**.
Expand Down Expand Up @@ -186,8 +186,8 @@ To view change over time as a percentage, create an **Area percentage** chart th

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. From the **Available fields** list, drag **Records** to the workspace.
3. Open the **Visualization type** dropdown, then select **Area**.
Expand Down Expand Up @@ -227,8 +227,8 @@ To determine the number of orders made only on Saturday and Sunday, create an ar

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. Open the **Visualization type** dropdown, then select **Area**.

Expand Down Expand Up @@ -269,8 +269,8 @@ To compare two time ranges, create a line chart that compares the sales in the c

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. Open the **Visualization type** dropdown, then select **Line**.
3. From the **Available fields** list, drag **Records** to the workspace.
Expand Down Expand Up @@ -301,8 +301,8 @@ To compare time range changes as a percent, create a bar chart that compares the

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. From the **Available fields** list, drag **Records** to the workspace.
3. In the layer pane, click **Count of records**.
Expand All @@ -327,8 +327,8 @@ Create a date histogram table and group the customer count metric by category, s

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. Open the **Visualization type** dropdown, then select **Table**.
3. From the **Available fields** list, drag **customer_id** to the **Metrics** field in the layer pane.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ Open the visualization editor, then make sure the correct fields appear.

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization**.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization**.

2. Make sure the **{{kib}} Sample Data Logs** {{data-source}} appears.

Expand Down Expand Up @@ -99,8 +99,8 @@ To visualize the **bytes** field over time:

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. From the **Available fields** list, drag **bytes** to the workspace.

Expand Down Expand Up @@ -163,8 +163,8 @@ The **Top values** function ranks the unique values of a field by another functi

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. From the **Available fields** list, drag **clientip** to the **Vertical axis** field in the layer pane.

Expand Down Expand Up @@ -213,8 +213,8 @@ Create a proportional visualization that helps you determine if your users trans

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. From the **Available fields** list, drag **bytes** to the **Vertical axis** field in the layer pane.
3. In the layer pane, click **Median of bytes**.
Expand Down Expand Up @@ -266,8 +266,8 @@ The distribution of a number can help you find patterns. For example, you can an

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. From the **Available fields** list, drag **bytes** to **Vertical axis** field in the layer pane.
3. In the layer pane, click **Median of bytes**.
Expand Down Expand Up @@ -298,8 +298,8 @@ Add a panel title:

1. Create a visualization.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. Open the **Visualization type** dropdown, then select **Treemap**.
3. From the **Available fields** list, drag **Records** to the **Metric** field in the layer pane.
Expand Down
8 changes: 4 additions & 4 deletions explore-analyze/dashboards/drilldowns.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ Use the [**Sample web logs**](../index.md#gs-get-data-into-kibana) data to creat
1. Add the **Sample web logs** data.
2. Create a new dashboard.

* {applies_to}`stack: ga 9.2` Select **Add** > **From library** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Add from library** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **From library** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Add from library** in the dashboard toolbar.

3. Add the following panel:

Expand Down Expand Up @@ -113,8 +113,8 @@ For example, if you have a dashboard that shows data from a Github repository, y
3. In the toolbar, click **Edit**.
4. Create a pie chart.

* {applies_to}`stack: ga 9.2` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0` Click **Create visualization** in the dashboard toolbar.
* {applies_to}`serverless:` {applies_to}`stack: ga 9.2+` Select **Add** > **Visualization** in the toolbar.
* {applies_to}`stack: ga 9.0-9.1` Click **Create visualization** in the dashboard toolbar.

2. From the **Chart type** dropdown, select **Pie**.
3. From the **Available fields** list, drag **machine.os.keyword** to the workspace.
Expand Down
Loading
Loading