|
1 | 1 | # Applies to |
2 | 2 |
|
3 | | -Starting with Elastic Stack 9.0, ECE 4.0, and ECK 3.0, documentation follows a [cumulative approach](https://www.elastic.co/docs/contribute-docs/how-to/cumulative-docs): instead of creating separate pages for each product and release, we update a single page with product- and version-specific details over time. |
| 3 | +Elastic documentation on [elastic.co/docs](https://www.elastic.co/docs) follows a [cumulative](https://www.elastic.co/docs/contribute-docs/how-to/cumulative-docs) model. We don't maintain versioned branches or separate copies of a page for each release. Instead, every page covers all supported versions, and writers use `applies_to` metadata to tag content with the versions, products, deployment models, and lifecycle states it applies to. |
4 | 4 |
|
5 | | -To support this, source files use a tagging system to indicate: |
| 5 | +:::{tip} |
| 6 | +You can use the [applies-to-tagging](https://github.com/elastic/elastic-docs-skills/tree/main/skills/authoring/applies-to-tagging) skill in Claude Code to validate and generate `applies_to` tags. [**Learn more**](https://github.com/elastic/elastic-docs-skills/tree/main#elastic-docs-skills) |
| 7 | +::: |
6 | 8 |
|
7 | | -* Which Elastic products and deployment models the content applies to. |
8 | | -* When a feature changes state relative to the base version. |
| 9 | +## Quick reference |
9 | 10 |
|
10 | | -This is what the `applies_to` metadata is for. It can be used at the [page](#page-level), [section](#section-level), or [inline](#inline-level) level to specify applicability with precision. |
| 11 | +When documenting a new feature or behavior, answer these two questions: |
11 | 12 |
|
12 | | -:::{note} |
13 | | -For detailed guidance, refer to [Write cumulative documentation](https://www.elastic.co/docs/contribute-docs/how-to/cumulative-docs). |
14 | | -::: |
| 13 | +1. **Where should I add `applies_to` metadata?** Find where your changes sit on the page and match to a type below. |
| 14 | +2. **What keys and values do I use?** Refer to the [key-value reference](#key-value-reference) for the full list of valid keys, lifecycles, and version formats. |
| 15 | + |
| 16 | +### Where should I put the `applies_to` metadata? |
| 17 | + |
| 18 | +| When | Use | |
| 19 | +|------|-----| |
| 20 | +| You're creating a new page | [Frontmatter](#page-level) | |
| 21 | +| You're adding a new section to an existing page | [Section-level annotation](#section-level) | |
| 22 | +| You're adding a single new item to a list or definition term | [Inline annotation](#inline-level) | |
| 23 | +| You're marking a single item as a technical preview | [Preview shorthand](#inline-level) | |
| 24 | +| You need to show entirely different content for each variant, not just tag the same content | [Versioned tabs](applies-switch.md) | |
| 25 | +| You're adding a version-specific note, tip, or warning | [Admonition annotation](admonitions.md) | |
| 26 | +| You're adding a version-specific dropdown | [Dropdown annotation](dropdowns.md) | |
15 | 27 |
|
16 | 28 | ## Syntax reference |
17 | 29 |
|
|
0 commit comments