-
Notifications
You must be signed in to change notification settings - Fork 133
v1.17.0 doc readiness
Checkpoint | Date (subject to change) | Details |
---|---|---|
New version doc setup | Nov 4 | See detailed work items here |
Relnotes: Call for notable changes | Nov 4 | Squad leads to provide updates |
Relnotes: CHANGELOG update cutoff | Nov 9 (Same day as Code Complete) | Doc squad to work with squads to complete review |
Relnotes: First draft review | Nov 10 | First run of release notes. Squad leads and the community to review |
Run TPSR, run relnotes scan again (pick up late changes) | Nov 11 (When final RC ready) | For TPSR, see Instructions. Pick up any late changes in release notes. |
Doc freeze, PR for publish ready | Nov 12 | |
Doc publish | Nov 13 | Work with Steve and Robbie |
Release promotion | Nov 14 - 15 | Slack, LinkedIn, Twitter, etc |
-
Archive the PDF of the previous version from the
master
branch. Rename it toZowe_Documentation_x.y.z.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
branchSearch 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 theconst CURRENT_ZOWE_VERSION = 'x.x.x'
row and thedescription: '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
tomaster
to get ready for publish (PR state should be green)- Fix all broken links
- For DCO failure, bypass DCO and inform relevant submitters to update the
DCO_signoffs
folder. - Inform build squad (Steve, Robbie) of the PR
- 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
- Doc readiness checklist
- Doc planning
- Doc maintainers
- What is the Pull Request process and how to submit a PR?
- Build and Archive Legacy Documentation
- How to check broken links
- How to build PDF
- How to add a new file to the site
- How to build the site
- How to prepare appendix for a new release
- How to embed videos in Zowe docs
- How to write what's new/release notes
- How to report documentation progress and status?
- How to author in Markdown?
- How to author content or a new release? What process to follow?