Skip to content

Adds table to dynamic tag logic explanation #1749

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 8 commits into from
Aug 25, 2025
Merged

Adds table to dynamic tag logic explanation #1749

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8b6915e
Adds table to dynamic tag logic explanation.
szabosteve Aug 18, 2025
acd0848
Relocates table.
szabosteve Aug 19, 2025
eccb5bb
Fixes syntax.
szabosteve Aug 19, 2025
7cdd132
Fine-tunes tag.
szabosteve Aug 19, 2025
9925726
Relocates and expands table.
szabosteve Aug 21, 2025
998a797
Merge branch 'main' into szabosteve/applies-to-table
szabosteve Aug 21, 2025
cd637e7
Update docs/contribute/_snippets/tag-processing.md
szabosteve Aug 25, 2025
aa589b3
Merge branch 'main' into szabosteve/applies-to-table
szabosteve Aug 25, 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
24 changes: 15 additions & 9 deletions docs/contribute/_snippets/tag-processing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,23 @@

Specifically for versioned products, badges will display differently when the `applies_to` key specifies a product version that has not been released to our customers yet.

* `Planned` (if the lifecycle is preview, beta, or ga)

Example: {applies_to}`stack: ga 99.99`
* `Deprecation planned` (if the lifecycle is deprecated)

Example: {applies_to}`stack: deprecated 99.99`
* `Removal planned` (if the lifecycle is removed)
The following table shows how badges for versioned products are displayed based on the release status for each lifecycle value. Hover over the example badges for the tooltip text.

Example: {applies_to}`stack: removed 99.99`
| Lifecycle | Release status | Badge text examples |
|-------------|----------------|---------------------------------------|
| preview | prerelease | {applies_to}`stack: preview 99.99` |
| | post-release | {applies_to}`stack: preview 9.1` |
| beta | prerelease | {applies_to}`stack: beta 99.99` |
| | post-release | {applies_to}`stack: beta 9.1` |
| ga | prerelease | {applies_to}`stack: ga 99.99` |
| | post-release | {applies_to}`stack: ga 9.1` |
| deprecated | prerelease | {applies_to}`stack: deprecated 99.99` |
| | post-release | {applies_to}`stack: deprecated 9.1` |
| removed | prerelease | {applies_to}`stack: removed 99.99` |
| | post-release | {applies_to}`stack: removed 9.1` |

This is computed at build time (there is a docs build every 30 minutes). The documentation team tracks and maintains released versions for these products centrally in [`versions.yml`](https://github.com/elastic/docs-builder/blob/main/config/versions.yml).

This is computed at build time (there is a docs build every 30 minutes). The documentation team tracks and maintains released versions for these products centrally in [`versions.yml`](https://github.com/elastic/docs-builder/blob/main/config/versions.yml).
When multiple lifecycle statuses and versions are specified in the sources, several badges are shown.

:::{note}
Expand Down
Loading