Skip to content

Commit b4c261c

Browse files
Apply review requests
1 parent cd3e03e commit b4c261c

File tree

1 file changed

+27
-41
lines changed

1 file changed

+27
-41
lines changed

docs/syntax/applies.md

Lines changed: 27 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,41 @@
1-
---
2-
applies_to:
3-
stack: ga 9.1
4-
deployment:
5-
eck: ga 9.0
6-
ess: beta 9.1
7-
ece: deprecated 9.2.0
8-
self: unavailable
9-
serverless:
10-
security: unavailable
11-
elasticsearch: beta
12-
observability: deprecated
13-
product: preview 9.5, deprecated 9.7
14-
---
15-
161
# Applies to
172

183
The `applies_to` metadata allows you to specify which product versions, deployment types, and environments a specific page, section, or line applies to. Documentation published using Elastic Docs V3 follows a [cumulative model](../contribute/index.md) where a single page covers multiple versions cumulatively over time, instead of creating separate pages for each minor release.
194

20-
### Syntax
5+
## When to use `applies_to`
6+
7+
Every page must include a [page-level `applies_to`](#page-annotations) tag to clearly define its scope and availability.
8+
9+
Use version tagging when:
10+
* A feature is introduced (e.g., preview, beta, or ga)
11+
* A feature is deprecated (e.g., deprecated)
12+
* A feature is removed (e.g., removed)
13+
14+
You don’t need version tagging for:
15+
* Typos, formatting, or style changes
16+
* Long-standing features being documented for the first time
17+
* Content updates that don’t reflect a feature lifecycle change
18+
19+
## Syntax
2120

2221
```
2322
<life-cycle> [version], <life-cycle> [version]
2423
```
2524

2625
Taking a mandatory [life-cycle](#life-cycle) with an optional version.
2726

27+
### Combined states
28+
You can specify multiple lifecycle states for the same product, separated by commas. For example:
29+
30+
```
31+
applies_to:
32+
stack: preview 9.1, ga 9.4
33+
```
34+
This shows that the feature was introduced in version 9.1 as a preview and became generally available in 9.4.
35+
2836
#### Life cycle
2937

30-
Both versioned and unversioned products use the same lifecycle tags, but only versioned products can be marked `ga`. Unversioned products are considered `ga` by default and don’t need specification.
38+
`applies_to` accepts the following lifecycle states:
3139

3240
* `preview`
3341
* `beta`
@@ -36,6 +44,8 @@ Both versioned and unversioned products use the same lifecycle tags, but only ve
3644
* `unavailable`
3745
* `ga`
3846

47+
Both versioned and unversioned products use the same lifecycle tags, but only versioned products can be marked `ga`. Unversioned products are considered `ga` by default and don’t need specification.
48+
3949
#### Version
4050

4151
Can be in either `major.minor` or `major.minor.patch` format
@@ -65,30 +75,6 @@ deprecated 9.9.0
6575
unavailable
6676
```
6777

68-
## When to use `applies_to`
69-
70-
Every page must include a [page-level `applies_to`](#page-annotations) tag to clearly define its scope and availability.
71-
72-
Use version tagging when:
73-
* A feature is introduced (e.g., preview, beta, or ga)
74-
* A feature is deprecated (e.g., deprecated)
75-
* A feature is removed (e.g., removed)
76-
77-
You don’t need version tagging for:
78-
* Typos, formatting, or style changes
79-
* Long-standing features being documented for the first time
80-
* Content updates that don’t reflect a feature lifecycle change
81-
82-
### Combined states
83-
You can specify multiple lifecycle states for the same product, separated by commas. For example:
84-
85-
```
86-
applies_to:
87-
stack: preview 9.1, ga 9.4
88-
```
89-
90-
This shows that the feature was introduced in version 9.1 as a preview and became generally available in 9.4.
91-
9278
## Structured model
9379

9480
![Applies To Model](images/applies.png)

0 commit comments

Comments
 (0)