search

uio-carpentry / organisational

For meeting minutes and other organisational stuff
Creative Commons Attribution 4.0 International
2 stars 11 forks source link

Rename checklists.md to workshop-guide.md #39 #46

Closed arockenberger closed 4 years ago

arockenberger commented 4 years ago

39

lexnederbragt commented 4 years ago

The word 'checklist' is derived from the Carpentries Handbook, see https://docs.carpentries.org/topic_folders/hosts_instructors/hosts_instructors_checklist.html. So I would be in favour of keeping it, maybe use Workshop Checklists instead. But it is not a big issue to me...

desireetreichler commented 4 years ago

I agree with both of you. The Carpentries however have a nested setup with an index page (called index.md by them) with general information and a table of content with links to all the checklists . Our UiO setup is somewhat less complicated and I thus don't think it matters so much what the file is called. But whatever name we use, it would be useful if it is consistent - i.e. file name and links in index/readme files further up in the hierarchy should be somewhat related.

Example: https://github.com/uio-carpentry/organisational -> this links to checklists. Either change this (and possibly other places) also to Workshop Guide, or keep checklist somewhere in the file name.

arockenberger commented 4 years ago

OK – it looks like this is not a straight-forward one. If I were to change the filename to "workshop-guide", I would also update the links in other documents that refer to it. I still think calling the document "checklists" is too unspecific, especially given that we have an actual checklist with the onboarding-checklist.

lexnederbragt commented 4 years ago

On further consideration I think workshop guide is OK.

arockenberger commented 4 years ago

Let’s go for it and see!