[SOLR-15817] Ensure refGuide upgrade notes are completed before announcing a release

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 9.0
• Component/s: documentation, release-scripts
• Assignee: Jan Høydahl
• Reporter: Jan Høydahl
• Created: 24/Nov/21 09:21
• Updated: 12/May/22 00:26
• Resolved: 01/Jan/22 16:47

Description

Now when we have started publishing the RefGuide as part of the actual release, we need to make sure it is ready. For the 8.11 release the announcement went out with a broken link to refGuide, and when the guide was published it lacked Upgrade Notes for 8.11.

The proposal is as I wrote in dev@email:

Early on, right after cutting the branch, the RM files a blocker JIRA issue with title e.g. "Complete Major changes and Upgrade Notes in RefGudie for 9.1".
Note that the RM will not need to be the one authoring the text (and not Cassandra either), but the release will be blocked on someone stepping up.
And of course we know that RCs can in theory still be voted upon while ref guide is being completed, but that blocker JIRA must be resolved before announcing the release.

I plan to add two steps to RM process - 1) to file that blocker JIRA, and 2) making sure the blocker is closed before announcing the release.

Issue Links

• links to: GitHub Pull Request #482