-
Notifications
You must be signed in to change notification settings - Fork 19
Adds cumulative docs contribution overview #1324
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
6815f45
Add cumulative docs contribution guidance
kosabogi 8dc9d75
Fixes links
kosabogi f651d38
Update docs/contribute/index.md
kosabogi 898d1ca
Update docs/contribute/index.md
kosabogi 78700fe
Nesting section and deleting note
kosabogi dc819fc
Adds more information
kosabogi 2851fe0
Merge branch 'main' into cumulative-docs-guide
Mpdreamz f8f9d0b
Update docs/contribute/index.md
kosabogi e58e8aa
Merge branch 'main' into cumulative-docs-guide
kosabogi bd1ca41
Merge branch 'main' into cumulative-docs-guide
kosabogi e94a667
Merge branch 'main' into cumulative-docs-guide
kosabogi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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 [ | |
* For **simple bugfixes and enhancements** --> [contribute on the web](on-the-web.md) | ||
* For **complex or multi-page updates** --> [Contribute locally](locally.md) | ||
|
||
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). | ||
|
||
#### Write cumulative documentation [#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. | ||
|
||
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. | ||
|
||
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. | ||
|
||
In order to achieve this, the markdown source files integrate a **tagging system** meant to identify: | ||
|
||
* Which Elastic products and deployment models the content applies to. | ||
* When a feature goes into a new state as compared to the established base version. | ||
|
||
This [tagging system](#applies-to) is mandatory for all of the public-facing documentation. | ||
|
||
##### The `applies_to` tag [#applies-to] | ||
|
||
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. | ||
|
||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @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) |
||
|
||
## Report a bug | ||
|
||
* 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 [ | |
|
||
## Work on docs-builder | ||
|
||
That sounds great! See [development](../development/index.md) to learn how to contribute to our documentation build system. | ||
That sounds great! See [development](../development/index.md) to learn how to contribute to our documentation build system. |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.