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/index.md
+24-1Lines changed: 24 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,29 @@ To contribute to earlier versions of the Elastic Stack, you must work with our [
24
24
* For **simple bugfixes and enhancements** --> [contribute on the web](on-the-web.md)
25
25
* For **complex or multi-page updates** --> [Contribute locally](locally.md)
26
26
27
+
Starting with Elastic Stack version 9.0, ECE 4.0, and ECK 3.0, a new set of docs is no longer published for every minor release. Instead, each page stays valid over time and incorporates version-specific changes directly within the content using a [cumulative approach](#cumulative-docs).
Cumulative documentation means that one page can cover multiple product versions, deployment types, and release stages. Instead of creating separate pages for each release, we update the same page with version-specific details.
32
+
33
+
This helps readers understand which parts of the content apply to their own ecosystem and product versions, without needing to switch between different versions of a page.
34
+
35
+
Following this approach, information for supported versions must not be removed unless it was never accurate. Instead, refactor the content to improve clarity or to include details for other products, deployment types, or versions.
36
+
37
+
In order to achieve this, the markdown source files integrate a **tagging system** meant to identify:
38
+
39
+
* Which Elastic products and deployment models the content applies to.
40
+
* When a feature goes into a new state as compared to the established base version.
41
+
42
+
This [tagging system](#applies-to) is mandatory for all of the public-facing documentation.
43
+
44
+
##### The `applies_to` tag [#applies-to]
45
+
46
+
Use the [`applies_to`](../syntax/applies.md) tag to indicate which versions, deployment types, or release stages each part of the content is relevant to.
47
+
48
+
You must always use the `applies_to` tag at the [page](../syntax/applies.md#page-annotations) level. Optionally, you can also use it at the [section](../syntax/applies.md#sections) or [inline](../syntax/applies.md#inline-applies-to) level if certain parts of the content apply only to specific versions, deployment types, or release stages.
49
+
27
50
## Report a bug
28
51
29
52
* It's a **documentation** problem --> [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml)*or*[Fix it myself](locally.md)
@@ -36,4 +59,4 @@ To contribute to earlier versions of the Elastic Stack, you must work with our [
36
59
37
60
## Work on docs-builder
38
61
39
-
That sounds great! See [development](../development/index.md) to learn how to contribute to our documentation build system.
62
+
That sounds great! See [development](../development/index.md) to learn how to contribute to our documentation build system.
0 commit comments