honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[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 <james.rodewig@elastic.co>
This commit is contained in:
debadair 2019-11-20 10:54:09 -08:00 committed by Deb Adair
parent 0f15736687
commit d3bc9b7fb2
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/README.asciidoc
View File

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