Skip to content

Commit eb65fea

Browse files
committed
versions.yml info
1 parent 19e2f36 commit eb65fea

File tree

4 files changed

+45
-5
lines changed

4 files changed

+45
-5
lines changed

docs/contribute/_snippets/tag-processing.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,19 @@
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

55
* `Planned` (if the lifecycle is preview, beta, or ga)
6+
7+
Example: {applies_to}`stack: ga 99.99`
68
* `Deprecation planned` (if the lifecycle is deprecated)
9+
10+
Example: {applies_to}`stack: deprecated 99.99`
711
* `Removal planned` (if the lifecycle is removed)
812

9-
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.
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/src/Elastic.Documentation.Configuration/versions.yml).
1016

1117
When multiple lifecycle statuses and versions are specified in the sources, several badges are shown.
1218

1319
:::{note}
1420
Visuals and wording in the output documentation are subject to changes and optimizations.
15-
:::
16-
17-
% todo: link to central config
21+
:::

docs/contribute/branching-strategy.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ Add an action as part of that repo’s release process for the release manager t
6262

6363
When these releases happen, create a PR against the [assembler file](https://github.com/elastic/docs-builder/blob/main/src/tooling/docs-assembler/assembler.yml) that defines the new `current` branch, to merge on release day.
6464

65+
:::{tip}
66+
Regardless of the branching strategy, you also need to update the current version in [versions.yml](https://github.com/elastic/docs-builder/blob/main/src/Elastic.Documentation.Configuration/versions.yml) as part of your release process. This version number is used in documentation variables and drives our [dynamic version badge logic](/contribute/cumulative-docs.md#how-do-these-tags-behave-in-the-output).
67+
:::
68+
6569

6670
## Workflow 1 (default): Continuous deployment
6771

docs/contribute/cumulative-docs.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ In order to achieve this, the markdown source files integrate a tagging system m
2929

3030
This tagging system is mandatory for all of the public-facing documentation. We refer to it as “[applies_to](https://elastic.github.io/docs-builder/syntax/applies/)” tags or badges.
3131

32+
## How version awareness works in Docs V3
33+
34+
Docs V3 uses a central version config called [versions.yml](https://github.com/elastic/docs-builder/blob/main/src/Elastic.Documentation.Configuration/versions.yml), which tracks the latest released versions of our products. It also tracks the earliest version of each product documented in the Docs V3 system (the earliest available on elastic.co/docs).
35+
36+
This central version config is used in certain inline version variables, and drives our [dynamic rendering logic](#how-do-these-tags-behave-in-the-output). This logic allows us to label documentation related to unreleased versions as `planned`, continuously release documentation, and document our Serverless and {{stack}} offerings in one place.
37+
3238
## Tagging products and deployment models
3339

3440
### Page-level frontmatter (mandatory)
@@ -122,7 +128,12 @@ We do not do date-based tagging for unversioned products.
122128
### For versioned products
123129

124130
:::{include} /syntax/_snippets/versioned-lifecycle.md
125-
:::
131+
:::
132+
133+
### Document features shared between serverless and {{stack}}
134+
135+
:::{include} /syntax/_snippets/stack-serverless-lifecycle-example.md
136+
:::
126137

127138
### Identify multiple states for the same content
128139

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
If a change is released in Serverless and will be released in a future version of the {{stack}}, you can add both a `serverless` and `stack` tag, indicating the version of the {{stack}} in which the feature will be released:
2+
3+
```
4+
---
5+
applies_to:
6+
serverless: ga
7+
stack: ga 9.2
8+
---
9+
```
10+
11+
Because these changes need to be published as soon as the feature is released in Serverless, you might need to publish your docs before the feature is available in the {{stack}}. To allow for this, Docs V3 [displays badges differently](/contribute/cumulative-docs.md#how-do-these-tags-behave-in-the-output) when the `applies_to` tag specifies a product version that has not yet been released to customers.
12+
13+
* A feature is tagged as available in a current Serverless release and a future {{stack}} version will render the following badges:
14+
15+
{applies_to}`serverless: ga`
16+
{applies_to}`stack: ga 99.99`
17+
18+
* After the {{stack}} version is released, the same badges will render with the version number without any changes to the badge value in the source.
19+
20+
{applies_to}`serverless: ga`
21+
{applies_to}`stack: ga 9.0`

0 commit comments

Comments
 (0)