Skip to content

Update applies_to example for same lifecycle, multiple versions #1945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 26, 2025
+20 −2
Merged

Update applies_to example for same lifecycle, multiple versions #1945

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb6105f
Update applies_to example for same lifecycle, multiple versions
vishaangelova Sep 25, 2025
fc9be69
Apply suggestions from code review
vishaangelova Sep 25, 2025
6c8eaeb
Add clarification about order of applies_to tags
vishaangelova Sep 26, 2025
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
4 changes: 2 additions & 2 deletions docs/contribute/cumulative-docs/example-scenarios.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -557,7 +557,7 @@ _Work in progress._

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

Sometimes, features and enhancements slip through into patch versions. In that case, the same functionality might be added for the first time to multiple patch versions at the same time.
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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe add a note that the author should manually ensure that the applies_tos should be in order: starting with later versions, ending with earlier versions? (The auto-ordering doesn't work when there are multiple inline applies_tos.)


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 @@ -572,7 +572,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, ga 9.0.6`
logged in debug logging. {applies_to}`stack: ga 9.1.2` {applies_to}`stack: ga 9.0.6`
```
::::
:::::
Binary file modified docs/contribute/cumulative-docs/images/example-multiple-patch.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions docs/syntax/_snippets/inline-level-applies-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,21 @@ This example shows how to use directly a key from the second level of the `appli
:::::
::::::

::::::{dropdown} The functionality is available in the same lifecycle in multiple versions

:::::{tab-set}

::::{tab-item} Output

- {applies_to}`stack: ga 9.1.2` {applies_to}`stack: ga 9.0.6`

::::

::::{tab-item} Markdown
```markdown
- {applies_to}`stack: ga 9.1.2` {applies_to}`stack: ga 9.0.6`
```
::::

:::::
::::::
Loading