Skip to content

Commit 4baa958

Browse files
shain-ify the guidelines page
Co-authored-by: shainaraskas <[email protected]>
1 parent 8fd042d commit 4baa958

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

docs/contribute/cumulative-docs/guidelines.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,19 @@ Start by asking yourself:
1616

1717
If the answer to at least one of these questions is _yes_, follow these guidelines to write cumulative documentation.
1818

19-
## Dimensions of applicability
19+
## What `applies_to` tags can communicate
2020

2121
### Type
2222

2323
In cumulative documentation, you can use `applies_to` to communicate:
2424

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).
2727

2828
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)
3030
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.
3232

3333
```
3434
<key>: <lifecycle> <version>
@@ -39,13 +39,13 @@ and [version](/contribute/cumulative-docs/reference.md#version) are make up the
3939
For each type of applicability information, you can add `applies_to` metadata at different levels:
4040

4141
* **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 products and deployment models.
4343
* **Section-level** annotations allow you to specify different applicability for individual sections
4444
when only part of a page varies between products or versions.
4545
% TO DO: Add when https://github.com/elastic/docs-builder/issues/1436 is complete
4646
% * **Element-level** annotations allow tagging block-level elements like tabs, dropdowns, and admonitions.
4747
% 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.
4949
This is useful for highlighting the applicability of specific phrases, sentences,
5050
or properties without disrupting the surrounding content.
5151

@@ -74,11 +74,9 @@ refer to [](/syntax/applies.md).
7474
Instead, contributors should be able to add them anywhere they need, and the system should
7575
be in charge of rendering them clearly.
7676

77-
% Source: https://github.com/elastic/kibana/pull/229485/files#r2231850710
78-
% * Create hierarchy of versioned information??
7977

8078
% Source: George's checklist
81-
* 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.
8280

8381
### Order of items
8482

@@ -162,7 +160,7 @@ Here are some common scenarios you might come across:
162160
* **Cumulative documentation is not meant to replace release notes.**
163161
* For example, if a feature becomes available in {{serverless-short}} and
164162
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.
166164
* **Consider carefully when the change is going to be published.**
167165
Read more about how publishing can vary between repos in [](/contribute/branching-strategy.md).
168166
* **Do not use date-based tagging for unversioned products.**
@@ -182,9 +180,9 @@ For unversioned products like {{serverless-short}} or {{ecloud}}:
182180
There is no need to label newly added GA content in unversioned products at the section or line level
183181
if it is already labeled as available at the page level.
184182
([example](/contribute/cumulative-docs/example-scenarios.md#unversioned-added))
185-
* If it is added in technical preview or beta and the related content is added to an existing page
183+
* If it is added in technical preview or beta, and the related content is added to an existing page
186184
that is already labeled as generally available in the unversioned product at the page level,
187-
also label the new technical preview or beta content at the section or line level.
185+
label the new technical preview or beta content at the section or line level.
188186
([example](/contribute/cumulative-docs/example-scenarios.md#unversioned-added))
189187
* When a feature in an unversioned product changes lifecycle state to `preview`, `beta`, `ga` or `deprecated`,
190188
replace the previous lifecycle state with the new lifecycle state.
@@ -216,7 +214,7 @@ For versioned products like the Elastic Stack:
216214
* When a feature in an unversioned product is removed, but the content also applies to
217215
another context (for example a feature is removed in both Kibana 9.x and Serverless),
218216
then it must be kept for any user reading the page that may be using a version of
219-
Kibana prior to the removal.
217+
the product prior to the removal.
220218
([example](/contribute/cumulative-docs/example-scenarios.md#removed))
221219

222220
## When to indicate something is NOT applicable
@@ -258,5 +256,4 @@ This is true for most situations. However, it can still be useful to call it out
258256
serverless: unavailable
259257
```
260258
````
261-
% I think we wanted to not specify stack here
262259

0 commit comments

Comments
 (0)