Lesson Example: Setup

Our lesson template is kept in the carpentries/styles repository. The styles repository is carefully curated so that changes made to it are easily mergable by downstream lessons. The styles repository contains various bits that take Markdown files and render them as a lesson web page. For more information on how to develop lessons and maintain them, see our lesson-example. It will walk you through the basics of lesson design and how to use GitHub, Markdown and Jekyll for lesson development. Follow the instructions below to make your own empty lesson in your own GitHub account. Once you’ve done that you can just write Markdown code and have lesson web pages just like the lesson-example and all of our other lessons, but with your lesson content.

Requirements:

Creating a New Lesson

We will assume that your user ID is timtomch and the name of your new lesson is data-cleanup.

  1. We’ll use the GitHub’s importer to make a copy of this repo in your own GitHub account. (Note: This is like a GitHub Fork, but not connected to the upstream changes)

  2. Put the URL of the styles repository (https://github.com/carpentries/styles) in the “Your old repository’s clone URL” box. Do not use the URL of this repository, as that will bring in a lot of example files you don’t actually want.

  3. Select the owner for your new repository. In our example this is timtomch, but it may instead be an organization you belong to.

  4. Choose a name for your lesson repository. In our example, this is data-cleanup.

  5. Make sure the repository is public.

  6. At this point, you should have a page like this:

    You can now click “Begin Import”. When the process is done, you can click “Continue to repository” to visit your newly-created repository.

    Through the Github interface you can begin to edit and

  7. If you want to work on the lesson from your local machine, you can now clone your newly-created repository to your computer:

    $ git clone -b gh-pages https://github.com/timtomch/data-cleanup.git
    

    Note that the URL for your lesson will have your username and chosen repository name.

  8. Go into that directory using:

    $ cd data-cleanup
    

    Note that the name of your directory should be what you named your lesson on the example this is data-cleanup.

  9. To be able to pull upstream style changes, you should manually add the styles repository as a remote called template:

     $ git remote add template https://github.com/carpentries/styles.git
    

    This will allow you to pull in changes made to the template, such as improvements to our CSS style files. (Note that the user name above is carpentries, not timtomch, since you are adding the master copy of the template as a remote.)

  10. Make sure you are using the gh-pages branch of the lesson template:

    $ git checkout gh-pages
    

    This will ensure that you are using the most “stable” version of the template repository. Since it’s being actively maintained by the Software Carpentry community, you could end up using a development branch that contains experimental (and potentially not working) features without necessarily realising it. Switching to the gh-branch ensures you are using the “stable” version of the template.

  11. Run bin/lesson_initialize.py to create all of the boilerplate files that cannot be put into the styles repository (because they would trigger repeated merge conflicts).

  12. Create and edit files as explained further in the episodes of this lesson.

  13. (requires Jekyll Setup from below) Preview the HTML pages for your lesson:

    $ make serve
    
  14. Commit your changes and the HTML pages in the root directory of your lesson repository and push to the gh-pages branch of your repository:

    $ cd data-cleanup
    $ git add changed-file.md changed-file.html
    $ git commit -m "Explanatory message"
    $ git push origin gh-pages
    
  15. Tell us where your lesson is so that we can add it to the appropriate index page(s).

Note:

  1. SSH cloning (rather than the HTTPS cloning used above) will also work for those who have set up SSH keys with GitHub.

  2. Once a lesson has been created, please submit changes for review as pull requests that contain only the modified Markdown files. Do not submit generated HTML.

  3. Some people have had intermittent errors during the import process, possibly because of the network timing out. If you experience a problem, please re-try; if the problem persists, please get in touch.

Setup Instructions for a specific existing lesson

  1. Installation instructions for core lessons are included in the workshop template’s home page, so that they are all in one place. The setup.md files of core lessons link to the appropriate sections of the workshop template page.

  2. Other lessons’ setup.md include full installation instructions organized by OS (following the model of the workshop template home page).

(Optional) Jekyll Setup for Lesson Development

If you want to set up Jekyll so that you can preview changes on your own machine before pushing them to GitHub, you must install the software described below. (Note: Julian Thilo has written instructions for installing Jekyll on Windows.)

  1. Ruby. This is included with Linux and Mac OS X; the simplest option on Windows is to use RubyInstaller. Make sure Ruby is upto date otherwise jekyll may fail. You can test your installation by running ruby --version. For more information, see the Ruby installation guidelines.

  2. RubyGems (the package manager for Ruby). You can test your installation by running gem --version.

  3. Jekyll. You can install this by running gem install jekyll. On macOS, a user does not have a permission to write to /Library/Ruby/Gems/. Run gem install jekyll --user-install instead.

  4. R Packages. We use knitr, stringr, and checkpoint to format lessons written in R Markdown, so you will need to install these to build R lessons (and this example lesson). The best way to install these packages is to open an R terminal and type:

    > install.packages('knitr', repos = 'https://', dependencies = TRUE)
    > install.packages('stringr', repos = 'https://cran.rstudio.com', dependencies = TRUE)
    > install.packages('checkpoint', repos = 'https://cran.rstudio.com', dependencies = TRUE)
    > install.packages('ggplot2', repos = 'https://cran.rstudio.com', dependencies = TRUE)
    

If you want to run bin/lesson_check.py (which is invoked by make lesson-check) you will need Jekyll (so that you have its Markdown parser, which is called Kramdown) and the PyYAML module for Python 3.