You should edit the
_config.yml configuration file in the root directory of your workshop to configure some site-wide variables and make the site function correctly:
carpentry- to tell us which carpentry workshop this is, possible values are (“swc”, “dc” or “lc”)
title- overall title for all pages
workshop_repo- the URL of your workshop repository on GitHub
workshop_site- the repository’s GitHub Pages URL
For example, if the URL for the repository is
the URL for the website will be
You should not need to modify any of the other values in
Home Page: Data
Your workshop’s home page lives in
which must define the following values in its header:
carpentrymust be either “dc” (for Data Carpentry), “swc” (for Software Carpentry) or “lc” (for Library Carpentry).
venueis the short name of the institution or group hosting the workshop, like “Euphoric State University”. It should not include the address or other details, since this value is displayed in a table on the main Software Carpentry website.
addressis the workshop’s address (including details like the room number). The address should be all on one line.
countrymust be a two-letter ISO-3166 code for the country in which the workshop is going to take place, such as “fr” (for France) or “nz” (for New Zealand) - see Wikipedia for a complete list.
languageis the language that will be used in the workshop. It must be an ISO 639-1 code. Note that two-letter codes mean different things for countries and languages: “ar” is Arabic when used for a language, but Argentina when used for a country.
latlngis the latitude and longitude of the workshop site (so we can put a pin on our map). You can use this site to find these values. You can not put spaces around the comma separating the latitude from the longitude.
humandateis the human-friendly start and end date for the workshop. Please use three-letter month names and abbreviations (e.g.,
July), since these values are displayed in a table on our websites. (Strictly speaking this information is redundant, since we require a machine-readable
enddate, but reliably translating those into human-readable dates is an interesting challenge…)
humantimeis the human-friendly start and end time for each day of the workshop, e.g., “09:00 am - 4:00 pm” or “09:00-16:00”. (We recognize that we ought to allow different start or end times on different days, but going down that path leads eventually to embedding iCal date/time specifications in our headers, which in turn leads to madness…)
startdateis the workshop’s starting date in YYYY-MM-DD format, such as
2015-07-01. You must use four digits for the year and two each for the month and day.
enddateis the workshop’s ending date in the same format. If your workshop is only one day long, the
enddatefield should be deleted. If your workshop has a more complicated schedule (e.g., a half day a week for four weeks), please delete the
enddatefield and only tell us its start date.
instructoris a comma-separated list of instructor names. The list must be enclosed in square brackets, and each name must be in double quotes, as in
["Alan Turing","Grace Hopper"]. Do not include other information (such as the word “instructor”) in these values.
helperis a comma-separated list of helper names formatted in the same way as the instructor names. If there are no helpers, use an empty list
contactis the contact email address to use for your workshop. If you do not provide a contact email address, your website will display the address for the workshop coordinators (who probably won’t be able to answer questions about the specific details of your workshop).
The header may optionally define the following:
etherpadis the URL for the Etherpad for your workshop. If you are not using an Etherpad, you can delete this line. You can create a carpentries etherpad here.
eventbriteis the multi-digit Eventbrite registration key. If you are using Eventbrite, the Software Carpentry administrators will give this to you. If you are using something else, you may delete this line. Note: this value must be given as a string in double quotes, rather than as a number.
Home Page: Schedule and Syllabus
You should edit the sections titled
so that they show what you’re actually planning to teach and when. These
files are located in the appropriate workshop folder (
Home Page: Setup
You should delete the pieces of the
related to software you will not be using in your workshop,
so that learners don’t spend time installing software they don’t need.
Setup: Installation tests
If you intend to use the installation-test scripts,
uncomment the paragraph linking to
setup/swc-installation-test-2.py as described below.
swc-installation-test-1.py is pretty simple, and just checks that
the students have a recent enough version of Python installed that
they can run
checks for a list of dependencies and prints error messages if a
package is not installed, or if the installed version is not current
enough. By default, the script checks for pretty much anything that
has ever been used at a Software Carpentry workshop, which is probably
not what you want for your particular workshop.
comment any dependencies you don’t need out of the
CHECKS list. You
might also want to skim through the minimum version numbers listed
where particular dependencies are defined (e.g.
('git', 'Git', (1, 7,
0), None)). For the most part, fairly conservative values have been
selected, so students with modern machines should be fine. If your
workshop has stricter version requirements, feel free to bump them
Similarly, the virtual dependencies can be satisfied by any of several
packages. If you don’t want to support a particular package (e.g. if
you have no Emacs experience and don’t want to be responsible for
students who show up with Emacs as their only editor), you can comment
out that particular
Updating the repository
If for some reason, such as the installation instructions having become disconnected with the current lesson material, you need to get changes from this repository into the clone of it with your workshop page, please follow the steps bellow:
Add the workshop-template repository as upstream:
$ git remote add upstream https://github.com/carpentries/workshop-template.git
Fetch the data from upstream repository (also know as the workshop-template repository):
$ git fetch upstream
Merge the new changes:
$ git merge upstream/gh-pages
When get conflicts, solve it and
$ git commit -a
Push the changes to GitHub:
$ git push origin gh-pages