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
+32-14Lines changed: 32 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,36 @@
1
1
# Applies to
2
2
3
-
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.
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
+
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.
8
+
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
+
11
+
## When and where to use `applies_to`
12
+
13
+
The `applies_to` metadata can be added at different levels in the documentation:
14
+
15
+
*[Page-level](#page-annotations) metadata is **mandatory** and must be included in the frontmatter. This defines the overall applicability of the page across products, deployments, and environments.
16
+
*[Section-level](#section-annotations) annotations allow you to specify different applicability for individual sections when only part of a page varies between products or versions.
17
+
*[Inline](#inline-annotations) annotations allow fine-grained annotations within paragraphs or definition lists. This is useful for highlighting the applicability of specific phrases, sentences, or properties without disrupting the surrounding content.
18
+
19
+
### Do’s and don’ts
20
+
21
+
✅ Use `applies_to` tags when features change state (`preview`, `beta`, `ga`, `deprecated`, `removed`) or when availability differs across deployments and environments.
22
+
23
+
✅ Use `applies_to` tags to indicate which product or deployment type the content applies to. This is mandatory for every page.
24
+
25
+
✅ Use applies_to tags when features change state in a specific update or release.
26
+
27
+
❌ Don't tag content-only changes like typos, formatting, or documentation updates that don't reflect feature lifecycle changes.
28
+
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
+
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
+
33
+
❌ Don't tag content-only changes like typos, formatting, or documentation updates that don't reflect feature lifecycle changes.
4
34
5
35
## Syntax
6
36
@@ -21,8 +51,6 @@ Taking a mandatory [life-cycle](#life-cycle) with an optional [version](#version
21
51
*`unavailable`
22
52
*`ga`
23
53
24
-
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.
25
-
26
54
### Version
27
55
28
56
Can be in either `major.minor` or `major.minor.patch` format
@@ -44,17 +72,7 @@ applies_to:
44
72
observability: removed
45
73
```
46
74
47
-
## When and where to use `applies_to`
48
-
49
-
✅ Use `applies_to` tags when features change state (`introduced`, `deprecated`, `removed`) or when availability differs across deployments and environments.
50
-
51
-
❌ Don't tag content-only changes like typos, formatting, or documentation updates that don't reflect feature lifecycle changes.
52
-
53
-
The `applies_to` metadata can be added at different levels in the documentation:
54
-
55
-
*[Page-level](#page-annotations) metadata is **mandatory** and must be included in the frontmatter. This defines the overall applicability of the page across products, deployments, and environments.
56
-
*[Section-level](#section-annotations) annotations allow you to specify different applicability for individual sections when only part of a page varies between products or versions.
57
-
*[Inline](#inline-annotations) annotations allow fine-grained annotations within paragraphs or definition lists. This is useful for highlighting the applicability of specific phrases, sentences, or properties without disrupting the surrounding content.
0 commit comments