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 mimicking the work of the software carpentries, so we essentially follow their guide (“Setup” episode, “Creating a new Lesson” section) 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.

After creating a new repository by importing the styles repository as described in the carpentry guide, this corresponds to the following commands:

# Starting from your important repository
git clone git@github.com:hsf-training/hsf-training-advanced-git-webpage.git
cd hsf-training-advanced-git-webpage
git checkout gh-pages
# For updating the style later
git remote add template https://github.com/hsf-training/hsf-styles.git
git config --local remote.template.tagOpt --no-tags
# Initialize blank content
python3 bin/lesson_initialize.py
# Add everything to git
git add .
git commit -m "Initial version"

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.