Scheduling early transition to Workbench
tobyhodges opened this issue · 10 comments
Short version: are you are willing to volunteer your lesson for early transition to The Carpentries Workbench
infrastructure?
Longer version below:
As I hope you are already aware, @zkamvar and the rest of the Curriculum Team are preparing to roll out the new lesson infrastructure, The Carpentries Workbench, across all of The Carpentries official lessons in early May 2023. This means that all Data Carpentry, Library Carpentry, and Software Carpentry lesson repositories will be modified to adopt the new infrastructure at the end of this month.
As you might imagine, coordinating a rollout like this involves a large amount of time and effort, and one thing that will really help us to keep to the schedule and avoid disruption for the community is to be able to prepare some lessons for
transition before the 1st May deadline.
With this in mind, I invite you to volunteer to schedule an early transition for theis lesson repository. If you expect to have time to adopt the Workbench version of the lesson repository in the next couple of weeks, please reply to let me know. As lesson Maintainers, these are the things you will need to be prepared to do for the transition:
- Be prepared to quickly merge pull requests from Zhian. These pull requests will help update the lesson and aid the transition process.
- Close any outstanding pull requests. Your repository currently has very few or zero open PRs, but we cannot rule out the possibility that someone will open more in the time between now and when the transition takes place. Open PRs will be invalidated when the transition takes place.
- Preview the lesson (in the https://github.com/fishtree-attempt organisation) when it is available. Zhian will open an issue in your repository, tagging you when the preview is available. You should reply on that issue if you notice any problems with the Workbench version of the lesson site and repository in the preview.
- Just before the transition happens, the repository will be temporarily set as read-only and an issue will be opened (see an example from the Maintainer Onboarding curriculum: carpentries/maintainer-onboarding#69)
- After the transition, delete and recreate any forks and local clones you have of the repository and then confirm that you have done so (you will be given specific instructions in an issue).
If you are willing and able to help us ensure a smooth rollout of the Workbench, please reply to let me know that you are happy to volunteer your lesson for early transition. If there is a specific date you would like the transition to take place (or that we should avoid), please also mention that.
Thank you for participating in the early transition to The Workbench. I have been able to render a preview of your lesson at https://fishtree-attempt.github.io/matlab-novice-inflammation.
I am tracking issues for your lesson in carpentries/lesson-transition#76. I will be updating the preview next week as I work on any remaining issues.
Please inspect the preview and make note in carpentries/lesson-transition#76 if you see anything that needs to be fixed (e.g extra templating, narrow tables, or malformed text).
hello, I just noticed that the links I provided in my earlier comment were incorrect. They ahve been updated now.
This lesson will be converted to use The Carpentries Workbench
To prevent accidental reversion of the changes, we are temporarily revoking
write access for all collaborators on this lesson:
If you no longer wish to have write access to this repository, you do not
need to do anything further.
- What you can expect from the transition 📹: https://carpentries.github.io/workbench/beta-phase.html#beta
- How to update your local clone 💻: https://carpentries.github.io/workbench/beta-phase.html#updating-clone
- How to update (delete) your fork (if you have one) 📹: https://carpentries.github.io/workbench/faq.html#update-fork-from-styles
If you wish to regain write access, please re-clone the repository on your machine and
then comment here with I am ready for write access :rocket: and the
admin maintainer of this repository will restore your permissions.
If you have any questions, please reply here and tag @zkamvar
The deed is done. The infrastructure takes a few minutes to bootstrap and cache the packages for the lesson build. Once the build is done, I will switch github pages to deploy from the gh-pages branch and you will have your workbench lesson.
Thank you all for your enthusiasm and your patience!
The Workbench version is now live: https://swcarpentry.github.io/matlab-novice-inflammation/
In addition, here is map of commits that were changed during the transition
Because there are no maintainers on this lesson, I will close this now. Note: the code/ folder will likely need to be moved to episodes/files/code/, but there are no links within the lesson content to this folder, so it might not be necessary.
The workbench version doesn't look to be live, BTW - it looks like the old version:
Oh that's because I haven't pulled the switch yet 🙈
It should be up in the next few seconds
FWIW, I built in these manual steps as opposed to doing them via the API so that there are failsafe measures in case something does go wrong.