[DOCS] Add maintenance releases to upgrade table#55012
[DOCS] Add maintenance releases to upgrade table#55012jrodewig merged 2 commits intoelastic:7.6from jrodewig:docs__maint-rel-upgrade-76
Conversation
Updates the supported upgrade path table in [Upgrade Elasticsearch][0] to include a new row for maintenance releases. For example, this row covers upgrading from 7.6.0 to 7.6.2. The new table row only displays for releases greater than n.x.0. For example, the new row will display for the 7.7.1 release but not the 7.7.0 release. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/setup-upgrade.html
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-core-infra (:Core/Infra/Packaging) |
DaveCTurner
left a comment
There was a problem hiding this comment.
I suggested some small changes, assuming that there's a macro for the number of the previous patch/minor version. If that's not available then this still looks like a good improvement.
| |Recommended upgrade path to {version} | ||
|
|
||
| ifeval::[ "{version}" != "{minor-version}.0" ] | ||
| |A previous {minor-version} version (e.g., {minor-version}.0) |
There was a problem hiding this comment.
This seems a bit awkward since this column otherwise contains only minor version number ranges. Is there a macro for the previous patch version? If so, could we say {minor-version}.0 if the current version is {minor-version}.1 and {minor-version}.0-{previous-patch-version} otherwise?
There was a problem hiding this comment.
I agree that the wording is a bit awkward. A range would be preferable.
Unfortunately, there is no attribute/macro for the previous patch version. We could add a {prev-patch-version} attribute to the appropriate Stack version attribute list, but we'd need to include it in for every version to avoid breaks. That would include n.x.0 versions, which could create issues.
If you'd prefer a range here, it would probably be simpler for us to hard code the maintenance releases and add an item to our release prep process.
There was a problem hiding this comment.
Ok, let's leave it like this.
| |<<rolling-upgrades,Rolling upgrade>> to {version} | ||
| endif::[] | ||
|
|
||
| |7.0–7.5 |
There was a problem hiding this comment.
Similarly, instead of 7.5 is there a macro for the previous minor version?
docs/reference/upgrade.asciidoc
Outdated
| * Between minor versions | ||
| * From 5.6 to 6.8 | ||
| * From 6.8 to {version} | ||
| * Between {minor-version} versions |
There was a problem hiding this comment.
I wonder if "between" might be read as implying you can change version in both directions within the 7.6.x series. How about "from any version since {major-version}.0 to {version}" and drop the "Between minor versions" line?
|
Thanks for your review @DaveCTurner. There is no macro for the previous patch release. Adding such a macro could cause issues for n.x.0 versions. Let me know if you have any suggestions or thoughts! |
| |Recommended upgrade path to {version} | ||
|
|
||
| ifeval::[ "{version}" != "{minor-version}.0" ] | ||
| |A previous {minor-version} version (e.g., {minor-version}.0) |
There was a problem hiding this comment.
Ok, let's leave it like this.
|
Thanks @DaveCTurner. |
Updates the supported upgrade path table in [Upgrade Elasticsearch][0] to include a new row for maintenance releases. For example, this row covers upgrading from 7.6.0 to 7.6.2. The new table row only displays for releases greater than n.x.0. For example, the new row will display for the 7.7.1 release but not the 7.7.0 release. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/setup-upgrade.html
Updates the supported upgrade path table in [Upgrade Elasticsearch][0] to include a new row for maintenance releases. For example, this row covers upgrading from 7.6.0 to 7.6.2. The new table row only displays for releases greater than n.x.0. For example, the new row will display for the 7.7.1 release but not the 7.7.0 release. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/setup-upgrade.html
Updates the supported upgrade path table in [Upgrade Elasticsearch][0] to include a new row for maintenance releases. For example, this row covers upgrading from 7.6.0 to 7.6.2. The new table row only displays for releases greater than n.x.0. For example, the new row will display for the 7.7.1 release but not the 7.7.0 release. [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/setup-upgrade.html
Updates the supported upgrade path table in Upgrade Elasticsearch
to include maintenance releases. For example, this covers upgrading
from 7.6.0 to 7.6.2.
The new table row only displays for releases greater than n.x.0. For
example, the new row will display for the 7.7.1 release but not the
7.7.0 release.
This PR targets 7.6 as that's the latest branch that will display the new row.
However, I plan to port to 7.7, 7.x, and master.
Preview: http://docs__maint-rel-upgrade-76.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/current/setup-upgrade.html
Closes #53787