Skip to content

Commit c103989

Browse files
Adds table to dynamic tag logic explanation (#1749)
* Adds table to dynamic tag logic explanation. * Relocates table. * Fixes syntax. * Fine-tunes tag. * Relocates and expands table. * Update docs/contribute/_snippets/tag-processing.md Co-authored-by: Colleen McGinnis <[email protected]> --------- Co-authored-by: Colleen McGinnis <[email protected]>
1 parent cf70003 commit c103989

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

docs/contribute/_snippets/tag-processing.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,23 @@
22

33
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.
44

5-
* `Planned` (if the lifecycle is preview, beta, or ga)
6-
7-
Example: {applies_to}`stack: ga 99.99`
8-
* `Deprecation planned` (if the lifecycle is deprecated)
9-
10-
Example: {applies_to}`stack: deprecated 99.99`
11-
* `Removal planned` (if the lifecycle is removed)
5+
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.
126

13-
Example: {applies_to}`stack: removed 99.99`
7+
| Lifecycle | Release status | Badge text examples |
8+
|-------------|----------------|---------------------------------------|
9+
| preview | prerelease | {applies_to}`stack: preview 99.99` |
10+
| | post-release | {applies_to}`stack: preview 9.1` |
11+
| beta | prerelease | {applies_to}`stack: beta 99.99` |
12+
| | post-release | {applies_to}`stack: beta 9.1` |
13+
| ga | prerelease | {applies_to}`stack: ga 99.99` |
14+
| | post-release | {applies_to}`stack: ga 9.1` |
15+
| deprecated | prerelease | {applies_to}`stack: deprecated 99.99` |
16+
| | post-release | {applies_to}`stack: deprecated 9.1` |
17+
| removed | prerelease | {applies_to}`stack: removed 99.99` |
18+
| | post-release | {applies_to}`stack: removed 9.1` |
19+
20+
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).
1421

15-
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).
1622
When multiple lifecycle statuses and versions are specified in the sources, several badges are shown.
1723

1824
:::{note}

0 commit comments

Comments
 (0)