Skip to content

Commit 768ef7d

Browse files
Restructure life-cycles and fix typos
1 parent 0726a4a commit 768ef7d

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

docs/syntax/applies.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,23 @@ Both versioned and unversioned products use the same lifecycle tags, but only ve
4040

4141
Can be in either `major.minor` or `major.minor.patch` format
4242

43+
Versioned products require a `version` tag to be used with the `lifecycle` tag. See [Syntax](#syntax):
44+
45+
```
46+
applies_to:
47+
stack: preview 9.1, ga 9.4
48+
deployment:
49+
ece: deprecated 9.2, removed 9.8
50+
```
51+
Unversioned products use `lifecycle` tags without a version:
52+
53+
```
54+
applies_to:
55+
serverless:
56+
elasticsearch: beta
57+
observability: removed
58+
```
59+
4360
#### Examples
4461

4562
```
@@ -62,25 +79,6 @@ You don’t need version tagging for:
6279
* Long-standing features being documented for the first time
6380
* Content updates that don’t reflect a feature lifecycle change
6481

65-
### Versioned vs. unversioned products
66-
67-
Versioned products require a `version` tag to be used with the `lifecycle` tag. See [Syntax](#syntax):
68-
69-
```
70-
applies_to:
71-
stack: preview 9.1, ga 9.4
72-
deployment:
73-
ece: deprecated 9.2, removed 9.8
74-
```
75-
Unversioned products use `lifecycle` tags without a version:
76-
77-
```
78-
applies_to:
79-
serverless:
80-
elasticsearch: beta
81-
observability: removed
82-
```
83-
8482
### Combined states
8583
You can specify multiple lifecycle states for the same product, separated by commas. For example:
8684

@@ -120,10 +118,12 @@ This allows you to annotate various facets as defined in [](../migration/version
120118
All documentation pages **must** include an `applies_to` tag in the YAML frontmatter. Use yaml frontmatter to indicate each deployment targets availability and lifecycle status.
121119

122120
``` yaml
121+
---
123122
applies_to:
124-
product: preview 9.5
123+
product: preview 9.5, ga 9.6
125124
products:
126-
-id: cloud-kubernetes
125+
- id: cloud-kubernetes
126+
---
127127
```
128128

129129
```yaml

0 commit comments

Comments
 (0)