Background
VIVO continues to mature its release practices, its coding practices, and its documentation practices.
VIVO creates a new wiki for each major or dot release. For minor dot releases (1.9.3 for example), additional release notes are placed in the dot release wiki.
Before Release
- Create a new wiki for the new release.
- Create and work documentation issues related to the release. Solicit reviewers for items "In Review"
- Create release notes for the release
- Hand written with table of contents for major new features and improvements
- Automated list of issues resolved in the release from JIRA. Copy the JIRA report to the end of the release notes page.
- Update the contributors to make sure everyone who participated in the release is recognized
- Incorporate release note content into documentation pages in addition to the release notes as needed (new pages for new features, or additions to existing pages, reshoot screen shots for UI changes, etc.)
- Catch up the new wiki to the current wiki for documentation done in the current production wiki since the new wiki was created.
With Release
On the day of release:
- Make a single PDF of the documentation wiki and save it as an attachment on the first page of the wiki
- Update the VIVO web site to point to the new release and the new documentation
- Update the Documentation sidebar macro (used in all the documentation wikis) to indicate the current production release.
- Update the Releases page to indicate the current production release. This page is inserted into other pages in the wiki