Zowe docs UI 2.0 cutover plan

Checkpoints

• Community testing and issue fix (including doc squad) - Jun 17 - 20
  • Report issues in https://github.com/zowe/docs-site/issues/1721.
• System demo - Jun 21
• GA - Jun 22
• Social promotion - Jun 23
• Education session - Jun 24

Migration plan

Before migration

• Communicate the impact on open PRs
  • Because the doc sidebar is changed, there might be issue when open PRs sync with the latest site 
• 7-days before the migration, send out notice via Slack, email, and OMP calendar!! 
• Book education session on OMP calendar
• Create a GitHub issue to track post-migration issues

During migration

• Pick a down time  
• Notice to the community at the day [Ashley]
• Sycn latest docs from the master branch to the zowe-docs-v2 branch 
• Update the Google Analytics tracking ID to use Zowe one in the config file before the merge

Post migration check

• Create an issue for tracking migration issues [Ashley]
• Follow the checklist to do a quick check of docs [Doc Squad, Community]
• Verify Algolia search 
• Verify Analytics data work correctly 
• Update the TPSR links to point to the master branch

Post migration promotion 

• Hold a training session that talks about how to work with the new site generator 
• Address any Q&As
• Create a demo video about the build process, any tips&tricks
• Write a blog about the new experience 
• Record a video that educates people how to use the doc site and how to submit issues and so on

Beta preview checklist

1. Launch the Zowe Docs UX 2.0 Preview Sandbox at https://zowe-docs.netlify.app/.

2. Verify TOC and welcome page.

   • Verify links on the welcome page
   • Welcome page image
   • Veify that nvbar and sidebar opens correctly
   • Toc spacing (horizontal, vertical)
   • Font size
   • Font styling
   • Highlight on selection
   • Expand and collapse behaviour of TOC/sidebar

3. Component documentation checklist

   Start reviewing your content and collect information, notes, and actions items.

   • Titles
   • Font styling
   • Style in both dark/light themes
   • Tables
   • Code Blocks
   • Notes
   • Cautions
   • Warnings
   • Numbered Lists
   • Bulleted Lists
   • Nested Lists
   • html links (external and internal)
   • Videos
   • Images / GIFs / Diagrams
   • mini-TOC

4. Versioned documentation

   • Click the version drop-down list and verify versioned component docs

If you find any issues, post them as a comment in this GitHub issue https://github.com/zowe/docs-site/issues/1721.

If you want to preview the site locally by building the site by yourself, clone the zowe-docs-v2 branch and follow the instructions in the README file.