accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Christopher Tubbs (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-4479) UPGRADING.md
Date Fri, 30 Sep 2016 22:40:20 GMT

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

Christopher Tubbs commented on ACCUMULO-4479:
---------------------------------------------

I think the dedicated upgrade doc is fine, but I think it should point to the most current
information on the website, because that can contain new information we find about the impact
on upgrading, after a release. So, yes, I think we should retroactively change the release
notes with updated information.

To be clear, I'm not against a dedicated upgrade doc... I'm against stale upgrade docs, which
is easy to achieve when we have all the details from a particular fixed point in time bundled
only in the release tarball.

> 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)

Mime
View raw message