Skip to content

Commit 08cadd1

Browse files
committed
more
1 parent 490dea0 commit 08cadd1

File tree

4 files changed

+19
-3
lines changed

4 files changed

+19
-3
lines changed

docs/contribute/_snippets/tag-processing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
`applies_to` tags are rendered as badges in the documentation output. They reproduce the "key + lifecycle status + version" indicated in the content sources.
22

3-
Specifically for versioned products, badges will display differently when the applies_to key specifies a product version that has not been released to our customers yet.
3+
Specifically for versioned products, badges will display differently when the `applies_to` key specifies a product version that has not been released to our customers yet.
44

55
* `Planned` (if the lifecycle is preview, beta, or ga)
66
* `Deprecation planned` (if the lifecycle is deprecated)
@@ -14,4 +14,4 @@ When multiple lifecycle statuses and versions are specified in the sources, seve
1414
Visuals and wording in the output documentation are subject to changes and optimizations.
1515
:::
1616

17-
% todo: link
17+
% todo: link to central config

docs/contribute/cumulative-docs.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Write cumulative documentation
22

3+
<!--
4+
This page explains our cumulative documentation philosophy, paired with examples. Component guidance for reference purposes goes in syntax/applies.md.
5+
-->
6+
37
In our markdown-based documentation system, we write docs cumulatively regardless of the [deployment model](deployment-models.md) selected.
48

59
**What does this mean?**

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
* The whole page is generally applicable to {{stack}} 9.0 and to {{serverless-short}}, but one specific section isn’t applicable to {{serverless-short}} (and there is no alternative for it):
22

3-
````markdown
3+
````md
44
---
55
applies_to:
66
stack: ga

docs/syntax/applies.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Applies to
22

3+
<!--
4+
This page explains concrete usage of the applies_to tag. Cumulative authoring philosophy and guidance goes in contribute/cumulative-docs.md.
5+
-->
6+
7+
38
Starting with Elastic Stack 9.0, ECE 4.0, and ECK 3.0, documentation follows a [cumulative approach](../contribute/cumulative-docs.md): instead of creating separate pages for each product and release, we update a single page with product- and version-specific details over time.
49

510
To support this, source files use a tagging system to indicate:
@@ -8,6 +13,11 @@ To support this, source files use a tagging system to indicate:
813

914
This is what the `applies_to` metadata is for. It can be used at the page, section, or inline level to specify applicability with precision.
1015

16+
## `applies_to` tags in the output
17+
18+
:::{include} /contribute/_snippets/tag-processing.md
19+
:::
20+
1121
## When and where to use `applies_to`
1222

1323
The `applies_to` metadata can be added at different levels in the documentation:
@@ -30,6 +40,8 @@ The `applies_to` metadata can be added at different levels in the documentation:
3040

3141
❌ If the product is not versioned (meaning all users are always on the latest version, like in serverless or cloud), you do not need to tag a new GA feature.
3242

43+
For detailed guidance, refer to [](/contribute/cumulative-docs.md).
44+
3345
## Syntax
3446

3547
The `applies_to` metadata supports an [exhaustive list of keys](#structured-model).

0 commit comments

Comments
 (0)