Skip to content

Commit 054f37f

Browse files
debadairjrodewig
andauthored
[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 39d298f commit 054f37f

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

docs/README.asciidoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,19 @@ See: https://github.com/elastic/docs
55

66
=== Backporting doc fixes
77

8-
* Doc bug fixes and enhancements to existing content should be made against master
9-
and backported as far as the current version. Backporting doc changes to earlier minor versions
10-
that are out of maintenance is often complicated due to content restructuring and is not required.
11-
12-
* Backport important fixes such as security updates that have a direct customer impact to all affected versions.
13-
14-
* Avoid backporting doc changes across major versions unless it’s an important fix or
15-
the change is related to upgrading from the last minor version of the previous major.
16-
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+
1719
* Do not backport doc changes to https://www.elastic.co/support/eol[EOL versions].
1820

19-
* Doc PRs opened against released (non-EOL) versions can be merged to that version,
20-
applied to master, and backported to the current version (where applicable).
21-
2221
=== Snippet testing
2322

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

0 commit comments

Comments
 (0)