[ 
https://issues.apache.org/jira/browse/ACCUMULO-4479?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15536226#comment-15536226
 ] 

Sean Busbey commented on ACCUMULO-4479:
---------------------------------------

{quote}
This is prone to being overlooked and forgotten. We should have generic 
version-agnostic information in UPGRADING.md, and put more specific per-release 
notes in an UPGRADING section on the release notes for specific upgrade issues. 
At the very least, the version of this document for the current release does 
not need to contain upgrade instructions for upgrading to previous releases.
{quote}

counter-point: if we don't support direct upgrades from all older versions to 
all newer versions, having a dedicated upgrade doc makes it much easier for 
folks who have to go through multiple upgrades, e.g. to get from version 1.4 to 
1.8.

If we're going to rely on release notes, will that mean that each maintenance 
release will need to preserve an "upgrade considerations" section from the .0 
release? Are we going to retroactively change the release notes for 1.5, 1.6, 
and 1.7 to include this information?

> UPGRADING.md
> ------------
>
>                 Key: ACCUMULO-4479
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-4479
>             Project: Accumulo
>          Issue Type: Task
>          Components: docs
>    Affects Versions: 1.8.0
>            Reporter: Christopher Tubbs
>             Fix For: 1.8.1, 2.0.0
>
>
> UPGRADING.md was not updated for the 1.8.0 release. I actually didn't even 
> realize we were putting notes about specific upgrade paths in a per-release 
> way inside our release.
> This is prone to being overlooked and forgotten. We should have generic 
> version-agnostic information in UPGRADING.md, and put more specific 
> per-release notes in an UPGRADING section on the release notes for specific 
> upgrade issues. At the very least, the version of this document for the 
> current release does not need to contain upgrade instructions for upgrading 
> to previous releases.
> The more information we have in our documentation which is written to 
> correspond to the current/next release, the more (undocumented) manual steps 
> are involved for a release manager, and the more likely these steps are going 
> to get overlooked and forgotten.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to