This repository holds the template for starting a new HSF Training module in the legacy carpentries style (see, for example, our training on CI/CD).
Note We happily do this for you! It's always best to talk to us first, if you plan to contribute to our curriculum.
To start a new module, install Cookiecutter and run
cookiecutter https://github.com/hsf-training/carpentry-cookiecutter/After answering the questions, you have a directory with a working setup and a README.md.
Follow the instructions in README.md to take a first look at the corresponding webpage.
Install pre-commit and install the corresponding hooks with
cd /path/to/your/module
pre-commit installAfter you initialized git and linked it to a github repository, follow the github guide to set up automatic deployment with github pages.
- Follow the "Jekyll Setup for Lesson Development" instructions of the carpentry tutorial setup instructions.
- If you are interested to study the pedagogical concepts behind the carpentries approach, head to their handbook
- The technological section of their handbook is a good starting point to create content right away
- The tutorial on creating content also gives a nice introduction (but perhaps a bit more from a technological standpoint)
This is so much to take in, I feel entirely overwhelmed and discouraged.
This is entirely normal, if you're new to the technology stack that we're using (Markdown, Jekyll, git, github, ...). But don't despair, we're here to help you! Simply write to us or join our weekly meeting, or join the Mattermost educators space and we'll help you get unstuck. We can also arrange a short meeting where we share screens and figure out problems.