The Dovetail #12: Updates from The Carpentries Workbench

This is the twelfth post in a series that we are calling “The Dovetail”, about the transition to The Carpentries Workbench (our new lesson infrastructure). In this series, we aim to keep members of The Carpentries community abreast of the current news about the Workbench.

If you are interested in participating in discussions around The Carpentries Workbench, or if you have questions, head over to our GitHub Discussions forum: https://github.com/carpentries/workbench/discussions

If you have used the workbench and would like to provide feedback, please tell us about your experience.

IT’S GONNA BE MAY

In our [previous blog post]({{ site.url }}/blog/2022/11/dovetail-11/), we outlined the goals of the beta phase, acknowledged the very real situation of limited volunteer time, and announced that we will convert all of our lessons in mid-April 2023. Since it was published, personal considerations have required me to reconsider the timeline and extend it. Thus, we will convert all of our lessons to use The Carpentries Workbench in May 2023. Moreover, all of the lessons in the beta phase will undergo their transitions to the beta stage synchronously in February 2023. In April 2023, these lessons will finalise their conversion and the default website will use The Workbench.

Why we are extending the deadline

Ultimately, we are doing this because it is better to do something right than to do something quickly. The first shift of the beta phase placed it right in the middle of a time of year when members of the community may not be readily available. This impacted the time for Maintainers to explore the lessons and it initial design of the beta phase impacted the time and resources for organisation. This next shift in the beta phase will mean the maintainers will have more time to explore and also talk with each other about the experiences they are having with The Workbench. It is my hope that, through this process, champions of The Workbench will arise to provide feedback and fuel for its improvement.

Time to explore the new lesson format

The transition to use The Workbench will make the lives of Instructors, Maintainers, contributors, and Core Team staff easier when it comes to teaching and maintaining lessons. While Instructors will see a new format to the lesson webpages, the Maintainers will see the repositories undergo a massive change. Thus, the first part of the beta phase is a way for the Maintainers to get a better sense of how the lesson repository differs in its new format without the risk of irreversibly modifying a lesson.

Efficiency for time and resources

When I [announced the beta phase]({{ site.url }}/blog/2022/05/workbench-beta/), I had intended for it to start in the middle of July and run through the end of October, giving us time to transition all of the lessons by December. The lessons were staggered on a weekly schedule to account for the time it would take for me to provide an automated transition script for each lesson in the beta phase. While I had taken into account Hofstadter’s law in planning the beta phase, situations beyond my control appeared and I had to delay the beta phase until October.

What I had not taken into account was the fact that I would be vastly increasing the amount of communication work required for such a project. If every lesson required communications before, at the beginning of, and after each stage of the beta phase, that means that I had 49 communications to send out over the beta phase period.

During this last reorganisation of the beta phase schedule, all lessons will enter the beta phase stages at the same time. This means all communications will be synchronous so core team time can be dedicated to maintenance and addressing Maintainer and Instructor questions.

Lessons Currently In the Beta Phase

The table below shows the status of lessons that are currently in the beta phase:

Updates to The Carpentries Workbench

Since 2022-11-16,

• {sandpaper} version 0.10.7 -> 0.11.2
  • The progress bar for episodes now reflects the fraction of time progressed according to the episode timings as opposed to fraction of episode pages visited. Thanks to an anonymous commenter to our workbench feedback form for this suggestion.
  • Syllabus timings are now formatted as 00h 00m to make it more clear that they reflect hours and minutes and not necessarily timestamps. Thanks to Ross James Parker and Toby Hodges for the suggestion.
  • Internal code and documentation has been updated
• {pegboard} 0.3.2
  • no updates :)
• {varnish} 0.2.9 -> 0.2.10
  • bullet points in callouts are now better aligned with the text (thanks to Sarah Stevens for finding this!)

To update your local Workbench installation, open R and use the following code:

# Enable repository from carpentries
options(repos = c(
  ropensci = 'https://carpentries.r-universe.dev',
  CRAN = 'https://cloud.r-project.org'))
# Download and install sandpaper in R
install.packages(c('tinkr', 'pegboard', 'sandpaper', 'varnish'))

Tips and Tricks for Using The Workbench

All lessons are set to rebuild every Tuesday at 00:00 UTC using the most recent versions of the Workbench packages. If there is an update to a Workbench component or an error in one of the builds, as a maintainer, you can run a new build and your lesson will be rebuilt with the latest versions of The Workbench.

Here are the steps:

Step 1: go to https://github.com/(ORG)/(REPO)/actions and click on the 01 Build and Deploy action in the sidebar

Step 2: fill in the information and click “Run Workflow”