Adding a glossary

[drcandacemakedamoore]

Instructions

Thanks for contributing! ❤️

If this contribution is for instructor training, please email the link to this contribution to
[email protected] so we can record your progress. You've completed your contribution
step for instructor checkout by submitting this contribution!

Keep in mind that lesson maintainers are volunteers and it may take them some time to
respond to your contribution. Although not all contributions can be incorporated into the lesson
materials, we appreciate your time and effort to improve the curriculum. If you have any questions
about the lesson maintenance process or would like to volunteer your time as a contribution
reviewer, please contact The Carpentries Team at [email protected].

You may delete these instructions from your comment.

- The Carpentries

[tompollard]

Thanks for the contribution @drcandacemakedamoore! A glossary seems like it could be useful as part of the materials. A couple of quick thoughts:

• Should we only include terms that come up in the materials somewhere? If so, perhaps we could add terms one by one, ensuring that they are addressed in the content (and that the glossary entry and teaching materials are consistent)?
• It would be great if we could provide a reference for each definition if possible, so we can make it clear that the definitions that we provide are established.
• I'm not the best person to review specific wording on individual entries, so it would be good if we could bring in someone else for this step.

I'm also trying to work out whether there is any guidance on what we should be putting in the reference.md file. Do you know if guidance exists anywhere?

I took a look at some of the established lesson materials, and they don't seem to contain a references.md file. e.g. https://github.com/swcarpentry/git-novice

[drcandacemakedamoore]

The example I used was the Carpentries Instructor training course ( Instructor Training: Summary and Setup (carpentries.github.io) <https://carpentries.github.io/instructor-training/> ) in terms of how a glossary might go in. In terms of terminology, feel free to adjust to whatever you think the main course needs. We want to add some episodes that may use more of these words, but this is for our own local version, so on the main version, you can pare down to what you feel matches the curriculum there.

…

On Thu, Nov 16, 2023 at 10:15 PM Tom Pollard ***@***.***> wrote: Thanks for the contribution @drcandacemakedamoore <https://github.com/drcandacemakedamoore>! A glossary seems like it could be useful as part of the materials. A couple of quick thoughts: - Should we only include terms that come up in the materials somewhere? If so, perhaps we could add terms one by one, ensuring that they are addressed in the content (and that the glossary entry and teaching materials are consistent)? - It would be great if we could provide a reference for each definition if possible, so we can make it clear that the definitions that we provide are established. - I'm not the best person to review specific wording on individual entries, so it would be good if we could bring in someone else for this step. I'm also trying to work out whether there is any guidance on what we should be putting in the reference.md file. Do you know if guidance exists anywhere? I took a look at some of the established lesson materials, and they don't seem to contain a references.md file. e.g. https://github.com/swcarpentry/git-novice — Reply to this email directly, view it on GitHub <#15 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AHMYSANVY6Y64HEAZTFDBZTYEZ7ARAVCNFSM6AAAAAA7GEOE7OVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMJVGMZDMNBRHA> . You are receiving this because you were mentioned.Message ID: <carpentries-incubator/machine-learning-responsible-python/pull/15/c1815326418 @github.com>