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
✅ Use `applies_to` tags when features change state (`preview`, `beta`, `ga`, `deprecated`, `removed`) or when
67
+
availability differs across deployments and environments.
68
+
69
+
✅ Use `applies_to` tags to indicate which product or deployment type the content applies to. This is mandatory for every
70
+
page.
71
+
72
+
✅ Use `applies_to` tags when features change state in a specific update or release.
73
+
74
+
❌ Don't tag content-only changes like typos, formatting, or documentation updates that don't reflect feature lifecycle
75
+
changes.
76
+
77
+
❌ You don’t need to tag every section or paragraph. Only do so if the context or applicability changes from what has
78
+
been established earlier.
79
+
80
+
❌ If the product is not versioned (meaning all users are always on the latest version, like in serverless or cloud), you
81
+
do not need to tag a new GA feature.
82
+
66
83
% TO DO: Open an issue to force the order in the code.
67
84
## Order of items
68
85
@@ -136,7 +153,7 @@ For the full list of supported `applies_to` keys, refer to [](/contribute/cumula
136
153
* For example, you should not use version tagging when fixing typos,
137
154
improving styling, or adding a long-forgotten setting.
138
155
139
-
### Examples[versions-examples]
156
+
### Example scenarios[versions-examples]
140
157
141
158
***A new feature is added to {{serverless-short}} or {{ecloud}}. How do I tag it?**
142
159
Cumulative documentation is not meant to replace release notes. If a feature becomes available in {{serverless-short}} and doesn’t have a particular lifecycle state to call out (preview, beta, deprecated…), it does not need specific tagging.
Copy file name to clipboardExpand all lines: docs/contribute/cumulative-docs/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,12 +32,12 @@ This extends to deprecations and removals: No information should be removed for
32
32
33
33
To achieve this, the Markdown source files integrate a tagging system meant to identify:
34
34
35
-
***Product- or deployment-specific availability**: When content applies to or functions differently between products or deployment types (for example, Elastic Cloud Serverless or Elastic Cloud Hosted).
36
-
***Version-specific functionality**: When features are introduced, modified, or removed in specific versions including lifecycle changes (for example, going from Beta to GA).
35
+
* When content applies to or functions differently between **products or deployment types**.
36
+
* When features are introduced, modified, or removed in specific **versions** including lifecycle changes.
37
37
38
38
This tagging system is mandatory for all of the public-facing documentation. We refer to it as `applies_to` tags or badges.
39
39
40
-
For more detailed guidance on contributing to cumulative docs, refer to [](/contribute/cumulative-docs/best-practices.md).
40
+
**For detailed guidance on contributing to cumulative docs, refer to [](/contribute/cumulative-docs/best-practices.md).**
Copy file name to clipboardExpand all lines: docs/syntax/_snippets/page-level-applies-examples.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
-
There are 3 typical scenarios to start from:
1
+
There are three typical scenarios to start from:
2
2
3
3
* The documentation set or page is primarily about using or interacting with Elastic Stack components or the Serverless UI:
4
4
5
5
```yml
6
-
---
6
+
---
7
7
applies_to:
8
8
stack: ga
9
9
serverless: ga
@@ -13,10 +13,10 @@ There are 3 typical scenarios to start from:
13
13
* The documentation set or page is primarily about orchestrating, deploying or configuring an installation (only include relevant keys):
14
14
15
15
```yml
16
-
---
16
+
---
17
17
applies_to:
18
18
serverless: ga
19
-
deployment:
19
+
deployment:
20
20
ess: ga
21
21
ece: ga
22
22
eck: ga
@@ -27,7 +27,7 @@ There are 3 typical scenarios to start from:
27
27
* The documentation set or page is primarily about a product following its own versioning schema:
28
28
29
29
```yml
30
-
---
30
+
---
31
31
applies_to:
32
32
edot_ios: ga
33
33
---
@@ -36,11 +36,11 @@ There are 3 typical scenarios to start from:
36
36
It can happen that it’s relevant to identify several or all of these dimensions for a page. Use your own judgement and check existing pages in similar contexts.
0 commit comments