Skip to content

Commit d3bc9b7

Browse files
debadairjrodewig
andcommitted
[DOCS] Clarify backport policy for important technical corrections. (#49131)
* [DOCS] Clarify backport policy for important technical corrections. * Update docs/README.asciidoc Co-Authored-By: James Rodewig <[email protected]>
1 parent 0f15736 commit d3bc9b7

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/README.asciidoc

+17
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,23 @@ Elasticsearch documentation build process.
33

44
See: https://github.com/elastic/docs
55

6+
=== Backporting doc fixes
7+
8+
* Doc changes should generally be made against master and backported through to the current version
9+
(as applicable).
10+
11+
* Changes can also be backported to the maintenance version of the previous major version.
12+
This is typically reserved for technical corrections, as it can require resolving more complex
13+
merge conflicts, fixing test failures, and figuring out where to apply the change.
14+
15+
* Avoid backporting to out-of-maintenance versions.
16+
Docs follow the same policy as code and fixes are not ordinarily merged to
17+
versions that are out of maintenance.
18+
19+
* Do not backport doc changes to https://www.elastic.co/support/eol[EOL versions].
20+
21+
=== Snippet testing
22+
623
Snippets marked with `[source,console]` are automatically annotated with
724
"VIEW IN CONSOLE" and "COPY AS CURL" in the documentation and are automatically
825
tested by the command `./gradlew -pdocs check`. To test just the docs from a

0 commit comments

Comments
 (0)