You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/syntax/applies.md
+9-11Lines changed: 9 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,8 @@
3
3
Starting with Elastic Stack 9.0, ECE 4.0, and ECK 3.0, documentation follows a [cumulative approach](../contribute/index.md): instead of creating separate pages for each product and release, we update a single page with product- and version-specific details over time.
4
4
5
5
To support this, source files use a tagging system to indicate:
6
-
• Which Elastic products and deployment models the content applies to.
7
-
• When a feature changes state relative to the base version.
6
+
*Which Elastic products and deployment models the content applies to.
7
+
*When a feature changes state relative to the base version.
8
8
9
9
This is what the `applies_to` metadata is for. It can be used at the page, section, or inline level to specify applicability with precision.
10
10
@@ -22,16 +22,14 @@ The `applies_to` metadata can be added at different levels in the documentation:
22
22
23
23
✅ Use `applies_to` tags to indicate which product or deployment type the content applies to. This is mandatory for every page.
24
24
25
-
✅ Use applies_to tags when features change state in a specific update or release.
25
+
✅ Use `applies_to` tags when features change state in a specific update or release.
26
26
27
27
❌ Don't tag content-only changes like typos, formatting, or documentation updates that don't reflect feature lifecycle changes.
28
28
29
29
❌ You don’t need to tag every section or paragraph. Only do so if the context or applicability changes from what has been established earlier.
30
30
31
31
❌ If the product is not versioned (meaning all users are always on the latest version, like in serverless or cloud), you do not need to tag a new GA feature.
32
32
33
-
❌ Don't tag content-only changes like typos, formatting, or documentation updates that don't reflect feature lifecycle changes.
34
-
35
33
## Syntax
36
34
37
35
```
@@ -77,7 +75,7 @@ applies_to:
77
75
### Lifecycle examples
78
76
79
77
#### Unversioned products
80
-
Unversioned products aren’t following a fixed versioning scheme and are released a lot more often than versioned products. All users are using the same version of this product.
78
+
Unversioned products don't follow a fixed versioning scheme and are released a lot more often than versioned products. All users are using the same version of this product.
81
79
* When a change is released in `ga`, it **doesn’t need any specific tagging**.
82
80
* When a change is introduced as preview or beta, use `preview` or `beta` as value for the corresponding key within the `applies_to`:
83
81
@@ -87,7 +85,7 @@ Unversioned products aren’t following a fixed versioning scheme and are releas
87
85
serverless: preview
88
86
---
89
87
```
90
-
* When a change introduces a deprecation, use deprecated as value for the corresponding key within the applies_to:
88
+
* When a change introduces a deprecation, use deprecated as value for the corresponding key within the `applies_to`:
91
89
92
90
```
93
91
---
@@ -162,7 +160,7 @@ applies_to:
162
160
163
161
### Page annotations
164
162
165
-
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. For a complete list of supported keys and values, see the [frontmatter syntax guide](./frontmatter.md).
163
+
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. For a complete list of supported keys and values, see the [frontmatter syntax guide](./frontmatter.md).
166
164
167
165
#### Page annotation examples
168
166
@@ -234,7 +232,7 @@ the `{applies_to}` directive **MUST** be preceded by a heading directly.
234
232
:::
235
233
236
234
237
-
Note that this directive needs triple backticks since its content is literal. See also [](index.md#literal-directives)
235
+
Note that this directive requires triple backticks since its content is literal. See also [](index.md#literal-directives)
238
236
239
237
````markdown
240
238
```{applies_to}
@@ -250,7 +248,7 @@ stack: ga 9.1
250
248
```
251
249
````
252
250
253
-
This will allow the yaml inside the `{applies_to}` directive to be fully highlighted.
251
+
This will allow the YAML inside the `{applies_to}` directive to be fully highlighted.
254
252
255
253
#### Section annotation examples
256
254
@@ -336,7 +334,7 @@ Property {preview}`<version>`
336
334
337
335

338
336
339
-
The above model is projected to the following structured yaml.
337
+
The above model is projected to the following structured YAML.
0 commit comments