|
2 | 2 |
|
3 | 3 | 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. |
4 | 4 |
|
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) |
12 | | - |
13 | | - Example: {applies_to}`stack: removed 99.99` |
14 | | - |
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). |
16 | | -When multiple lifecycle statuses and versions are specified in the sources, several badges are shown. |
17 | | - |
18 | | -:::{note} |
19 | | -Visuals and wording in the output documentation are subject to changes and optimizations. |
20 | | -::: |
21 | | - |
22 | | -The following table shows how the badge text and corresponding tooltip text vary by release status for each lifecycle value. Hoover over the example badges for tooltip text. |
| 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. |
23 | 6 |
|
24 | 7 | | Lifecycle | Release status | Badge text | |
25 | 8 | |-------------|----------------|-----------------------------------------------------------------------------------| |
26 | | -| preview | prerelease | Planned | |
| 9 | +| preview | prerelease | {applies_to}`stack: preview 99.99` | |
27 | 10 | | | post-release | `<KEY> PREVIEW <VERSION>` <br><br> example: {applies_to}`stack: preview 9.1` | |
28 | | -| beta | prerelease | Planned | |
| 11 | +| beta | prerelease | {applies_to}`stack: beta 99.99` | |
29 | 12 | | | post-release | `<KEY> BETA <VERSION>` <br><br> example: {applies_to}`stack: beta 9.1` | |
30 | | -| ga | prerelease | Planned | |
| 13 | +| ga | prerelease | {applies_to}`stack: ga 99.99` | |
31 | 14 | | | post-release | `<KEY> <VERSION>` <br><br> example: {applies_to}`stack: ga 9.1` | |
32 | | -| deprecated | prerelease | Deprecation planned | |
| 15 | +| deprecated | prerelease | {applies_to}`stack: deprecated 99.99` | |
33 | 16 | | | post-release | `<KEY> DEPRECATED <VERSION>` <br><br> example: {applies_to}`stack: deprecated 9.1`| |
34 | | -| removed | prerelease | Removal planned | |
| 17 | +| removed | prerelease | {applies_to}`stack: removed 99.99` | |
35 | 18 | | | post-release | `<KEY> REMOVED <VERSION>` <br><br> example: {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). |
| 21 | + |
| 22 | +When multiple lifecycle statuses and versions are specified in the sources, several badges are shown. |
| 23 | + |
| 24 | +:::{note} |
| 25 | +Visuals and wording in the output documentation are subject to changes and optimizations. |
| 26 | +::: |
0 commit comments