Documentation feedback from frobnitzem

[bernhold]

Originally by email on 2022-04-14 from @frobnitzem to @bernhold

README.md should reference the additional files in that repo: https://github.com/bssw-tutorial/tutorial-management/blob/main/master-labels-milestones.json - isn't described

https://github.com/bssw-tutorial/tutorial-management/blob/main/tutorial-workflow.md - isn't described

• should probably change title to "deploying a tutorial" and reference from workflow end
• also, that doc. mentions bssw-tutorial website, presentations, and hands-on materials -- so should have links. This is helpful info to turn into a per-presenter check-list as well.
  • would be good to put fixed metadata into this doc or note to copy from previous metatada.
  • potentially duplicates Update presentations

Comments:

• Structure & Organization:

  • https://github.com/bssw-tutorial/tutorial-management/blob/main/Github-organization-structure-and-management.md - should be discussed for moving to ideas-productivity main repository?

• High-Level Workflow

  • "Finalize" should be more measurable definition of done. I suspect most of these are finalized when all calendar items have been set & checked against the venue's timeline.
  • "follow up on venue requirements" (misspelling) - should indicate that this is regular communication with organizers and tutorial presentation team
  • "update artifacts on website" is unclear. I think this is referring to "tutorial-workflow" (deployment) above.
  • Do we have post-delivery items?