Skip to content

[DOCS] Clarify backport policy for important technical corrections. #49131

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.

Sign up for GitHub

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 5 commits into from
Nov 20, 2019
Merged

[DOCS] Clarify backport policy for important technical corrections. #49131

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
64b8d89
[DOCS] Clarify backport policy for important technical corrections.
debadair Nov 15, 2019
fc1aaf3
Update docs/README.asciidoc
debadair Nov 15, 2019
2307946
Update docs/README.asciidoc
debadair Nov 15, 2019
e261ac0
Update docs/README.asciidoc
debadair Nov 15, 2019
970f530
Incorporated feedback.
debadair Nov 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions docs/README.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,19 @@ See: https://github.com/elastic/docs

=== Backporting doc fixes

* Doc bug fixes and enhancements to existing content should be made against master
and backported as far as the current version. Backporting doc changes to earlier minor versions
that are out of maintenance is often complicated due to content restructuring and is not required.

* Backport important fixes such as security updates that have a direct customer impact to all affected versions.

* Avoid backporting doc changes across major versions unless it’s an important fix or
the change is related to upgrading from the last minor version of the previous major.

* 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].

* Doc PRs opened against released (non-EOL) versions can be merged to that version,
applied to master, and backported to the current version (where applicable).

=== Snippet testing

Snippets marked with `[source,console]` are automatically annotated with
Expand Down