coderefinery / manuals

Diverse operation manuals for CodeRefinery workshops and lesson design.
https://coderefinery.github.io/manuals/
Creative Commons Attribution 4.0 International
9 stars 13 forks source link

Workshop roles and playbook cleanup #223

Closed samumantha closed 1 year ago

samumantha commented 1 year ago

FYI that I am working on this currently.

Done:

I think this will need a few iterations and more context for the new role pages, but maybe it could be a starting point? I mainly thought of having pages for the background info of roles mentioned in the playbook. They could of course also just link to the role overview, let's check that possibility also! Two roles that are now a bit unclear is the host and exercise coordinator. As their tasks overlap. Maybe we can figure this out from the upcoming workshop, how they should be called and their tasks distributed?

As usual feel free to edit and/or cherry-pick or disregard :)

rkdarst commented 1 year ago

Looks like good work reviewing everything! It all looks good to me, at least as well as I have read and with the time I have now to read.

For workshop-playbook.md, maybe the whole checklist part could be put in triple-backquote quoting to protect from these warnings?

bast commented 1 year ago

For workshop-playbook.md, maybe the whole checklist part could be put in triple-backquote quoting to protect from these warnings?

which warnings?

rkdarst commented 1 year ago

In the files-changed view, we see a 'myst' reference target not found: for the MD links that don't have a target. Since it's processed as a structured document, not opaque HTML links. (and incidentally for anyone interested, myst is a new role that myst-parser introduced that: tries to link to a document, if not tries to link to a reference, if not treats it as opaque HTML link and doesn't think about it - or something like that). RST has a similar default you can choose but it treats it as a literal text if not found - though I always do "explicit is better than implicit")

bast commented 1 year ago

OK I will merge and look for warnings locally as follow-up. I want to merge this to also unblock the other PR.