Adds cumulative docs contribution overview #1324
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
leemthompo
reviewed
May 30, 2025
leemthompo
reviewed
May 30, 2025
|
|
||
| Use the `applies_to` tag to indicate which versions, deployment types, or release stages each part of the content is relevant to. Refer to the [Applies to syntax guide](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/syntax/applies) for more details. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
@charlotte-hoblik this should be emphasized in the applies_to reference itself too: it should be hyper clear that page-level applies_to are mandatory, and how we use the lower-level ones to write [cumulative docs](linky link)
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
leemthompo
reviewed
May 30, 2025
Thank you for your comments and suggestions! I've applied them, added a bit more information, and restructured the section slightly. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📸 Preview
This PR adds contributor guidance for writing cumulative documentation, relevant for Elastic Stack 9.0 and later.
It includes a short overview of the cumulative docs model and navigation links for the instructions for using the applies_to tag at the page, section, and inline levels.