Workshop Template Enhancement Proposal

This post originally appeared on the Software Carpentry website.

Over the last couple of years, many emails and issues on GitHub requested moving the setup instructions in the Workshop Template to a separate page for valid reasons. To provide some reference, see swcarpentry/DEPRECATED-bc#415, swcarpentry/DEPRECATED-bc#729, swcarpentry/workshop-template#194 and swcarpentry/workshop-template#408.

What did we discover during those years and trials?

Finding the balance to accommodate long time and advanced instructors, novice or intermediate instructors and learners is as hard as carrying a watermelon with a tea spoon. So why are we having this discussion again?

Last year, we changed the Workshop Template by adding some ‘if-clauses’ so that Software Carpentry, Data Carpentry and Library Carpentry instructors could share the same template, see workshop-template#393. In part because of minor differences in how Software Carpentry, Data Carpentry and Library Carpentry lessons and workshops are structured, the ‘if-clauses’ weren’t enough for Data Carpentry and Library Carpentry to use the Workshop Template. With plans to create more lessons in the short future under the umbrella called “The Carpentries”, the urge to move the setup instructions has reappeared and we need to nail it.

I put a prototype in place, see swcarpentry/workshop-template#459, that demonstrates how we can require the lead instructor to only list within the Workshop Template index.html’s YAML header the lessons that will be used during the workshop and let some Javascript code fetch the latest installation instructions for those lessons.

The proposal idea has as advantages:

  • reduction in the number of lines that need to be edited in the workshop page, that is, 3-5 lines in the YAML header instead of many open/close comments;
  • reduction of confusion where the files with instructions to install a given software can be found, as all instructions are in the lesson that will be taught;
  • avoid the ugly and hard to deal with <iframe> element, <iframe> size can’t be responsive;
  • reduction in the amount of time to propagate some important changes, e.g. that learners can’t use Firefox Quantum because the SQLite3 add-on isn’t compatible.

Some drawbacks will happen:

  • one-time customizations will require more work, basically to clone a repository to customize the installation instructions;
  • instability due to client-side Javascript code, it might not work in 5-years from now; and
  • increase of page load/rendering time (I’m talking about much less than 1 second).

The drawbacks are minimal compared with the advantages.

By “forcing” instructors to clone the lessons they will teach, we will reduce the problem of instructors and learners being surprised with some changes in the lesson during their pre-workshop night of sleep. And the installation instructions will be out of date in less than 5 years so Javascript stopping working can even be something positive because the reader will do another search for more updated instructions.

For this to work, all lessons will need to improve the Setup page that they already have by mainly copying and pasting part of the current content in the Workshop Template page, for example, see this change to the Git lesson and this change to the Python lesson. This change offers the opportunity to require learners to install any specific package or to download any set of files that will be used. In addition to it, some things can be improved in the Javascript code to provide a better user experience.

This post is only the start of the conversation. All comments are welcome in swcarpentry/workshop-template#459. No change will be made without a technical and rolling plan consensus.

Dialogue & Discussion

Comments must follow our Code of Conduct.

Edit this page on Github