Skip to content

v1.18.0 doc readiness

nannanli edited this page Dec 16, 2020 · 2 revisions

Timeline

Checkpoint Date (subject to change) Actual date Details
New version doc setup Dec 9 Dec 9 See detailed work items here
Relnotes: Call for notable changes Dec 9 Dec 9 Squad leads to provide updates
Relnotes: CHANGELOG update cutoff (Same day as Code Complete) Doc squad to work with squads to complete review
Relnotes: First draft review Dec 10 First run of release notes. Squad leads and the community to review
Run TPSR, run relnotes scan again (pick up late changes) (When final RC ready) For TPSR, see Instructions. Pick up any late changes in release notes.
Doc freeze, PR for publish ready Dec 12
Doc publish Dec 13 tbd Work with Steve and Robbie
Release promotion Dec 14 - 15 tbd Slack, LinkedIn, Twitter, etc

Complete basic site configuration

  • Archive the PDF of the previous version from the master branch. Rename it to Zowe_Documentation_1.17.0.pdf.

  • Required for Major and Minor releases: Archive the master branch (See instructions)

    Ensure that the build is successful. Otherwise, there will be many broken links when the staging branch is updated. For patch releases (third digit update),

  • Bump the release version in the docs-staging branch

    Search and update the release version number in the documentation where appropriate. Usually the following files need to be updated:

    • docs-site/docs/.vuepress/config.js (TOC and navigation): Update the const CURRENT_ZOWE_VERSION = 'x.x.x'row and the description: 'Version x.x.x LTS' row.
    • docs-site/docs/README.md (homepage): Update the version and the PDF download links.
    • docs-site/docs/.vuepress/versions.json (drop-down menu): Update the URI to the previous version. Add the new version at the beginning.
  • Update Algolia search (See instructions)

  • Update BoM (manual, ask in the #zowe-build channel)

  • When final RC is ready: Run TPSRs (See Instructions)

  • 2-3 days before the release date: Create PR to merge docs-staging to master to get ready for publish (PR state should be green)

    • Fix all broken links
    • For DCO failure, bypass DCO and inform relevant submitter to update the DCO_signoffs folder.
    • Inform build squad of the PR

Run release notes process

  • Immediately after the previous release is published: Update the release notes file summary-of-changes.md to add a placeholder section for the upcoming release (should include three sections: notable changes, new features and enhancements, bug fixes).
  • Inform squad writers to review the individual CHANGELOGs
  • Email and Slack to ask all squad leads and the community to provide notable changes entry
  • Pull CHANGELOGs content for the latest release to the release notes document
  • Email and Slack to ask all squad leads to review the first release notes draft
  • Email and Slack to ask all squad leads to confirm the final draft