[ACCUMULO-4479] UPGRADING.md

• Type: Task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.8.0
• Fix Version/s: 1.7.3, 1.8.1, 2.0.0
• Component/s: docs
• Assignee: Michael Wall
• Reporter: Christopher Tubbs
• Created: 29/Sep/16 16:56
• Updated: 04/Dec/17 17:40
• Resolved: 09/Feb/17 15:51

Description

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.

Issue Links

• is related to: ACCUMULO-4747 Create a unified upgrade reference
• relates to: ACCUMULO-3551 Write 1.7.0 upgrade instructions
• links to: GitHub Pull Request #212
• links to: GitHub Pull Request #216