Creating a HSF module from scratch

If…

then this is for you! If you already have a module of some kind and want to update it with the HSF style, see here.

Creating the repository and getting started

We recommend you to let us do this part, so that you can start with the content right away!

Our training modules are mimicing the work of the software carpentries, so we essentially follow their guide to set this up, but please be aware of the following changes:

We have probably recommended you to directly create your repository in our github organization and already selected a name for it, but of course you can also start development in your private github.

Resources

Here are a few links to keep handy that can be helpful when building your module

Filling in content

After the last section, you should have repository that creates a blank carpentry style lesson.

What to not edit

Additional steps

FAQ

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.