diff --git a/docs/contribute/_snippets/tag-processing.md b/docs/contribute/_snippets/tag-processing.md index 32227ff2f..8b9fd2e67 100644 --- a/docs/contribute/_snippets/tag-processing.md +++ b/docs/contribute/_snippets/tag-processing.md @@ -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}