[BEAM-11693] Post 2.26.0 Release Tasks

• Type: Improvement
• Status: Open
• Priority: P3
• Resolution: Unresolved
• Component/s: project-management
• Assignee: Unassigned
• Reporter: Robert Burke
• Created: 26/Jan/21 23:23
• Updated: 04/Jun/22 19:48

Description

Umbrella Jira for updates to the release guide based on lostluck's experience releasing 2.26.0.

1. Improve the formatting consistency of the release documentation
   1.  Formatting of the markdown version (eg. WRT linebreaks).
   2. Improve readability of sections through bolding highlighting.
   3. Grammar errors and typos.
2. Improve the getting started tasks (be explicit on installed dependencies up front. and other environment assumptions).
3. Make the use of arbitrary version numbers consistent / Glossary of SCRIPT_SUBSTITUTIONS at the top.
4. Describe the "big picture" of a release to get the manager better situated.

Anything else while I'm editing that can help.

Issue Links

• links to: [Github] Pull Request #13815 (lostluck)
• links to: GitHub Pull Request #13815