docs.carpentries.org
docs.carpentries.org copied to clipboard
carpentries
Maintainers section seems incomplete
From one of the maintainers:
I don't find all the information I expect in the maintainer section such as:
MAINTAINERS * Step for Maintainer Onboarding process * Template emails * Maintainer Onboarding lesson (https://carpentries.github.io/maintainer-onboarding/index.html) * Maintainer operation i.e. day to day work with information such as: - How to deal with issues (most information is available in the Maintainer Onboarding lesson) + How to label issues + How to get help (slack, help-wanted label, etc.) - How to update the lesson template style (something I have never done so I don't know anything about it) - How to be kept informed (slack, maintainer meetings, lesson development)
* Step for scheduling a Bonanza/bug BBQI also miss information on the role of maintainers in the life cycle of a lesson. For instance I was not a maintainer when SWC moved from python 2 to python 3 but in general such evolution can happen and I don't really know how they are handled by the Carpentries. In addition, some lessons (such as Data Carpentry Geospatial) are not "mature" yet and still under development. It has an impact on the maintainer (both in terms on involvment and type of work).
Finally I miss a section for CONTRIBUTORS: I mean guidance for whoever wants to contribute to lessons (and submit issues or answer to existing issues), become an instructor, run workshops, become an instructor of instructors, etc.
To do list:
- [x] Step for Maintainer Onboarding process
- [x] Template emails
- [x] Maintainer Onboarding lesson (https://carpentries.github.io/maintainer-onboarding/index.html)
- Maintainer operation i.e. day to day work with information such as:
- [x] How to deal with issues (most information is available in the Maintainer Onboarding lesson)
- [x] How to label issues
- [x] How to get help (slack, help-wanted label, etc.)
- [ ] How to update the lesson template style (something I have never done so I don't know anything about it)
- [x] How to be kept informed (slack, maintainer meetings, lesson development)
I've added some of this information about put in placeholders for the other two items in the checklist above. Will be adding the last bits of information at a later point.
@ErinBecker This is an old issue - it is still relevant? For the two unchecked points:
- If the information about how to deal with issues is in the Maintainer onboarding, do we also want to have it in this handbook?
- For the lesson template style, I know @fmichonneau has been doing a lot of work on this. François, do you have suggestions on what do include here? I've updated things in the style repo but I don't know how to make those changes reach the lessons.
Yes - this is still super incomplete. Can you add to our agenda for tomorrow to plan out what needs to be done here?
@fmichonneau @ErinBecker @tobyhodges @zkamvar Is this something the curriculum team is still working on?
@maneesha This is a topic of active discussion among the Maintainers at the moment, so this is not the right time to try to add this content. I have made a note to revisit this issue in early June.
PR #735 addresses the fourth bullet point in the above checklist. @tobyhodges will be submitting another PR to address the remaining checklist item, after which point this issue can be closed.
The final bullet is How to update the lesson template style
Is this something @zkamvar could address?
I can address this. FWIW, this is one of those things that I didn't want to spend too much energy on because the changes in the new lesson infrastructure will remove the need for this process.
Pinging @zkamvar How to update the lesson template style is the only item on this list. You noted it will soon be irrelevant. Can we close this?