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/contribute/cumulative-docs/guidelines.md
+12-15Lines changed: 12 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,19 +16,19 @@ Start by asking yourself:
16
16
17
17
If the answer to at least one of these questions is _yes_, follow these guidelines to write cumulative documentation.
18
18
19
-
## Dimensions of applicability
19
+
## What `applies_to` tags can communicate
20
20
21
21
### Type
22
22
23
23
In cumulative documentation, you can use `applies_to` to communicate:
24
24
25
-
***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). Read more in [Product and deployment model tags](#products-and-deployment-models).
26
-
***Feature lifecycle and version-related functionality**: When features are introduced, modified, or removed in specific versions including lifecycle changes (for example, going from Beta to GA). Read more in [Tagging version-related changes](#versions).
25
+
***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). Read more in [Product and deployment model applicability](#products-and-deployment-models).
26
+
***Feature lifecycle and version-related functionality**: When features are introduced, modified, or removed in specific versions, including lifecycle changes (for example, going from Beta to GA). Read more in [Version and product lifecycle applicability](#versions).
27
27
28
28
Both types of applicability are added as part of the same `applies_to` tagging logic.
29
-
The type of applicability is the [keys](/contribute/cumulative-docs/reference.md#key)
29
+
The product or deployment type is the [key](/contribute/cumulative-docs/reference.md#key)
30
30
and the [feature lifecycle](/contribute/cumulative-docs/reference.md#lifecycle)
31
-
and [version](/contribute/cumulative-docs/reference.md#version)are make up the value.
31
+
and [version](/contribute/cumulative-docs/reference.md#version) make up the value.
32
32
33
33
```
34
34
<key>: <lifecycle> <version>
@@ -39,13 +39,13 @@ and [version](/contribute/cumulative-docs/reference.md#version) are make up the
39
39
For each type of applicability information, you can add `applies_to` metadata at different levels:
40
40
41
41
***Page-level** metadata is **mandatory** and must be included in the frontmatter.
42
-
This defines the overall applicability of the page across products, deployments, and environments.
42
+
This defines the overall applicability of the page across productsand deployment models.
43
43
***Section-level** annotations allow you to specify different applicability for individual sections
44
44
when only part of a page varies between products or versions.
45
45
% TO DO: Add when https://github.com/elastic/docs-builder/issues/1436 is complete
46
46
% * **Element-level** annotations allow tagging block-level elements like tabs, dropdowns, and admonitions.
47
47
% This is useful for ...
48
-
***Inline** annotations allow fine-grained annotations within paragraphs or definition lists.
48
+
***Inline** annotations allow fine-grained annotations within paragraphs or lists.
49
49
This is useful for highlighting the applicability of specific phrases, sentences,
50
50
or properties without disrupting the surrounding content.
51
51
@@ -74,11 +74,9 @@ refer to [](/syntax/applies.md).
74
74
Instead, contributors should be able to add them anywhere they need, and the system should
*Don’t overload with exclusions unless it is necessary - If a page is only about Elastic Cloud Hosted, no need to say serverless: unavailable, just add deployment: ess:
79
+
*Use `unavailable` sparingly. For example, if a page is only about Elastic Cloud Hosted, don't add a `serverless: unavailable` tag. Refer to [When to indicate something is NOT applicable](#when-to-indicate-something-is-not-applicable) for specific guidance.
82
80
83
81
### Order of items
84
82
@@ -162,7 +160,7 @@ Here are some common scenarios you might come across:
162
160
***Cumulative documentation is not meant to replace release notes.**
163
161
* For example, if a feature becomes available in {{serverless-short}} and
164
162
doesn’t have a particular lifecycle state to call out (preview, beta, deprecated…),
165
-
it does not need specific tagging.
163
+
it does not need specific tagging. However, it does need a release note entry to document the change.
166
164
***Consider carefully when the change is going to be published.**
167
165
Read more about how publishing can vary between repos in [](/contribute/branching-strategy.md).
168
166
***Do not use date-based tagging for unversioned products.**
@@ -182,9 +180,9 @@ For unversioned products like {{serverless-short}} or {{ecloud}}:
182
180
There is no need to label newly added GA content in unversioned products at the section or line level
183
181
if it is already labeled as available at the page level.
0 commit comments