Skip to content

Commit 66076ea

Browse files
deduplicate
1 parent dd02c04 commit 66076ea

File tree

5 files changed

+49
-67
lines changed

5 files changed

+49
-67
lines changed

docs/_docset.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ toc:
4040
children:
4141
- file: index.md
4242
- file: best-practices.md
43-
- file: reference.md
4443
- file: content-patterns.md
44+
- file: reference.md
4545
- file: branching-strategy.md
4646
- file: add-repo.md
4747
- file: release-new-version.md

docs/contribute/cumulative-docs/best-practices.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,23 @@ For each type of applicability information, you can add `applies_to` metadata at
6363
% Reference: https://github.com/elastic/kibana/pull/229485/files#r2231850710
6464
% * Create hierarchy of versioned information??
6565

66+
✅ 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+
6683
% TO DO: Open an issue to force the order in the code.
6784
## Order of items
6885

@@ -136,7 +153,7 @@ For the full list of supported `applies_to` keys, refer to [](/contribute/cumula
136153
* For example, you should not use version tagging when fixing typos,
137154
improving styling, or adding a long-forgotten setting.
138155

139-
### Examples [versions-examples]
156+
### Example scenarios [versions-examples]
140157

141158
* **A new feature is added to {{serverless-short}} or {{ecloud}}. How do I tag it?**
142159
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.

docs/contribute/cumulative-docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ This extends to deprecations and removals: No information should be removed for
3232

3333
To achieve this, the Markdown source files integrate a tagging system meant to identify:
3434

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.
3737

3838
This tagging system is mandatory for all of the public-facing documentation. We refer to it as `applies_to` tags or badges.
3939

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).**
4141

4242
### When _not_ to tag content
4343

docs/syntax/_snippets/page-level-applies-examples.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
There are 3 typical scenarios to start from:
1+
There are three typical scenarios to start from:
22

33
* The documentation set or page is primarily about using or interacting with Elastic Stack components or the Serverless UI:
44

55
```yml
6-
---
6+
---
77
applies_to:
88
stack: ga
99
serverless: ga
@@ -13,10 +13,10 @@ There are 3 typical scenarios to start from:
1313
* The documentation set or page is primarily about orchestrating, deploying or configuring an installation (only include relevant keys):
1414

1515
```yml
16-
---
16+
---
1717
applies_to:
1818
serverless: ga
19-
deployment:
19+
deployment:
2020
ess: ga
2121
ece: ga
2222
eck: ga
@@ -27,7 +27,7 @@ There are 3 typical scenarios to start from:
2727
* The documentation set or page is primarily about a product following its own versioning schema:
2828

2929
```yml
30-
---
30+
---
3131
applies_to:
3232
edot_ios: ga
3333
---
@@ -36,11 +36,11 @@ There are 3 typical scenarios to start from:
3636
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.
3737

3838
```yml
39-
---
39+
---
4040
applies_to:
4141
stack: ga
4242
serverless: ga
43-
deployment:
43+
deployment:
4444
ess: ga
4545
ece: ga
4646
eck: ga

docs/syntax/applies.md

Lines changed: 20 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -11,50 +11,14 @@ To support this, source files use a tagging system to indicate:
1111
* Which Elastic products and deployment models the content applies to.
1212
* When a feature changes state relative to the base version.
1313

14-
This is what the `applies_to` metadata is for. It can be used at the page, section, or inline level to specify
15-
applicability with precision.
14+
This is what the `applies_to` metadata is for. It can be used at the [page](#page-annotations),
15+
[section](#section-annotations), or [inline](#inline-annotations) level to specify applicability with precision.
1616

17-
## `applies_to` tags in the output
18-
19-
:::{include} /contribute/_snippets/tag-processing.md
20-
:::
21-
22-
## When and where to use `applies_to`
23-
24-
The `applies_to` metadata can be added at different levels in the documentation:
25-
26-
* [Page-level](#page-annotations) metadata is **mandatory** and must be included in the frontmatter. This defines the
27-
overall applicability of the page across products, deployments, and environments.
28-
* [Section-level](#section-annotations) annotations allow you to specify different applicability for individual sections
29-
when only part of a page varies between products or versions.
30-
* [Inline](#inline-annotations) annotations allow fine-grained annotations within paragraphs or definition lists. This
31-
is useful for highlighting the applicability of specific phrases, sentences, or properties without disrupting the
32-
surrounding content.
33-
34-
### Dos and don’ts
35-
36-
✅ Use `applies_to` tags when features change state (`preview`, `beta`, `ga`, `deprecated`, `removed`) or when
37-
availability differs across deployments and environments.
38-
39-
✅ Use `applies_to` tags to indicate which product or deployment type the content applies to. This is mandatory for every
40-
page.
41-
42-
✅ Use `applies_to` tags when features change state in a specific update or release.
43-
44-
❌ Don't tag content-only changes like typos, formatting, or documentation updates that don't reflect feature lifecycle
45-
changes.
46-
47-
❌ You don’t need to tag every section or paragraph. Only do so if the context or applicability changes from what has
48-
been established earlier.
49-
50-
❌ If the product is not versioned (meaning all users are always on the latest version, like in serverless or cloud), you
51-
do not need to tag a new GA feature.
52-
53-
For detailed guidance, refer to [](/contribute/cumulative-docs/index.md).
17+
**For detailed guidance, refer to [](/contribute/cumulative-docs/index.md).**
5418

5519
## Syntax
5620

57-
The `applies_to` metadata supports an [exhaustive list of keys](#structured-model).
21+
The `applies_to` metadata supports an [exhaustive list of keys](#key).
5822

5923
When you write or edit documentation, only specify the keys that apply to that content.
6024
Each key accepts values with the following syntax:
@@ -71,21 +35,6 @@ Where:
7135

7236
Note that a key without any value doesn't show any badge in the output.
7337

74-
### Key
75-
76-
:::{include} /_snippets/applies_to-key.md
77-
:::
78-
79-
### Lifecycle
80-
81-
:::{include} /_snippets/applies_to-lifecycle.md
82-
:::
83-
84-
### Version
85-
86-
:::{include} /_snippets/applies_to-version.md
87-
:::
88-
8938
Versioned products require a `version` tag to be used with the `lifecycle` tag. See [Syntax](#syntax):
9039

9140
```
@@ -104,6 +53,22 @@ applies_to:
10453
observability: removed
10554
```
10655

56+
### Key
57+
58+
:::{include} /_snippets/applies_to-key.md
59+
:::
60+
61+
### Lifecycle
62+
63+
:::{include} /_snippets/applies_to-lifecycle.md
64+
:::
65+
66+
### Version
67+
68+
:::{include} /_snippets/applies_to-version.md
69+
:::
70+
71+
10772
## Examples
10873

10974
### Lifecycle examples

0 commit comments

Comments
 (0)