Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Scheduling early transition to Workbench #65

Open
tobyhodges opened this issue Apr 12, 2023 · 14 comments
Open

Scheduling early transition to Workbench #65

tobyhodges opened this issue Apr 12, 2023 · 14 comments

Comments

@tobyhodges
Copy link
Member

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:

  1. Be prepared to quickly merge pull requests from Zhian. These pull requests will help update the lesson and aid the transition process.
  2. 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.
  3. 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.
  4. 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: Transition to Workbench carpentries/maintainer-onboarding#69)
  5. 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.
@tobyhodges
Copy link
Member Author

Hi @Helysalgado @clarallebot we are getting ready for an early transition for this lesson, and we have prepared a schedule for early lesson transitions.

Please check that document to see the date we have planned for transitioning this lesson, and adjust the sheet if a different date would be more convenient for you (no more than three lessons per day, please!). The README sheet gives more information. If we don't hear from you, we will go ahead with the transition on the date shown in that document.

@Helysalgado
Copy link
Contributor

Helysalgado commented Apr 17, 2023 via email

@clarallebot
Copy link
Contributor

Works for me too. Thanks!
Clara

@zkamvar zkamvar mentioned this issue Apr 21, 2023
Merged
@zkamvar
Copy link
Contributor

zkamvar commented Apr 21, 2023

Hello, the preview for this lesson is in https://fishtree-attempt.github.io/shell-novice-es/
The repository that created the lesson is https://github.com/fishtree-attempt/shell-novice-es/tree/main
Please inspect this and make sure that everything looks okay.

I am tracking the progress of transition here: carpentries/lesson-transition#81

Please note: This lesson was not initially tagged for early transition, so I may not perform the transition until Monday the 24th.

Just before I perform the transtion, I will make a comment with instructions.

@Helysalgado
Copy link
Contributor

Helysalgado commented Apr 21, 2023 via email

@zkamvar
Copy link
Contributor

zkamvar commented Apr 21, 2023

Hello,

It is the end of my day, so I will make the transition for this lesson on Monday.

Thank you for your patience!

@clarallebot
Copy link
Contributor

Hi Zhian and Heladia,
I agree, this looks great.
The only thing I noticed is that the navigation text that I am guessing is part of the lesson template is all in English, while the lesson is in Spanish. For example, Next, Previous, Keypoints, Back to top, Expand all solutions, etc. It happened a bit in the previous version (e.g. the menu of Home, setup, Episodes, etc is all in English), in this version there are a few more. I don't think it is a big deal at this point, just something to keep in mind.

Another small detail. Should it be Keypoints or Key Points? It is spelled differently in the menu at the top and in the box at the bottom of the lesson.
Thanks for all the work!

@zkamvar
Copy link
Contributor

zkamvar commented Apr 24, 2023

The only thing I noticed is that the navigation text that I am guessing is part of the lesson template is all in English, while the lesson is in Spanish. For example, Next, Previous, Keypoints, Back to top, Expand all solutions, etc. It happened a bit in the previous version (e.g. the menu of Home, setup, Episodes, etc is all in English), in this version there are a few more. I don't think it is a big deal at this point, just something to keep in mind.

This is an issue we have been tracking for a while carpentries/sandpaper#205. In short: I am working to implement the multilingual menus in The Workbench lessons after the transition in a way that will be more sustainable than the previous method. Once the fix happens, this lesson will automatically have menus in Spanish.

Another small detail. Should it be Keypoints or Key Points? It is spelled differently in the menu at the top and in the box at the bottom of the lesson.

👀 GOOD CATCH! Can you open an issue in https://github.com/carpentries/workbench/issues? That should definitely be fixed on my end.

@zkamvar
Copy link
Contributor

zkamvar commented Apr 24, 2023 •
edited
Loading

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.

  1. What you can expect from the transition 📹: https://carpentries.github.io/workbench/beta-phase.html#beta
  2. How to update your local clone 💻: https://carpentries.github.io/workbench/beta-phase.html#updating-clone
  3. 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

@zkamvar
Copy link
Contributor

zkamvar commented Apr 24, 2023

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!

@clarallebot
Copy link
Contributor

Wonderful!
I did open the issue about Keypoints.
Thank you for all the work you are putting into this, you are making it very easy :)

@zkamvar
Copy link
Contributor

zkamvar commented Apr 24, 2023

The Workbench version is now live: https://swcarpentry.github.io/shell-novice-es/

In addition, here is map of commits that were changed during the transition

@zkamvar zkamvar mentioned this issue Apr 24, 2023
Closed
@Helysalgado
Copy link
Contributor

Helysalgado commented Jun 2, 2023 via email

@zkamvar
Copy link
Contributor

zkamvar commented Jun 2, 2023

@Helysalgado access granted!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@zkamvar @tobyhodges @Helysalgado @clarallebot