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.

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

Migrating this lesson to the Workbench in 2025 #29

Open
tobyhodges opened this issue Jan 17, 2025 · 4 comments
Open

Migrating this lesson to the Workbench in 2025 #29

tobyhodges opened this issue Jan 17, 2025 · 4 comments

Comments

@tobyhodges
Copy link
Member

Hi lesson maintainers! 👋 as announced on The Carpentries blog earlier this week, the Curriculum Team will cease support for our previous lesson infrastructure (https://github.com/carpentries/styles) in The Carpentries Incubator at the end of 2025. After 31 December, any lessons remaining in the Incubator with the previous infrastructure will be archived.

Next steps

We describe a few possible courses of action you can take this year:

1. Get help with migrating this lesson

If you want to keep developing this lesson in The Carpentries Incubator, please migrate it to use The Carpentries Workbench this year. The Curriculum Team can help you with this: we are hosting monthly Lesson Transition Coworking Sessions where you can come and work on migrating your lesson with support, or if you prefer you can open an issue on the carpentries/lesson-transition repository to request that we do the initial transition for you. (More details of the process, coworking sessions, etc are in the blog post linked above.)

2. Transfer your lesson out of the Incubator

The Workbench provides several accessibility and usability improvements over the previous infrastructure, and we really do recommend that you transition to use it if possible. However, if you cannot or do not want to migrate this lesson to The Carpentries Workbench, you could transfer the project out of the Incubator to another GitHub organization/user. Any one of you with Admin access to the repository can initiate this transfer via the Danger Zone in the repository general settings.

We would prefer not to see you go, though! Please respond on this thread if you have questions or concerns so that we can better understand your need for the previous infrastructure. If you do transfer the repository out of the Incubator, please contact the Curriculum Team to let us know so that we can adjust our internal records.

3. Archive or delete the repository

If you no longer have interest or capacity to continue developing this lesson, you can archive or delete the repository altogether. As a rule of thumb, we recommend archiving a project with some history of development in case somebody else in the community wants to revive the project in the future (the Lesson Developer Handbook contains some advice on steps you can take before archiving the lesson). If you never really got started with developing the lesson, i.e. it has little or no commit history/drafted content, please delete the repository instead.

In either case, please contact the Curriculum Team to let us know that you are archiving/deleting your repository so that we can adjust our internal records.

Thanks so much for being part of The Carpentries Incubator community! ❤️

@tompollard
Copy link
Collaborator

thanks @tobyhodges, i'm hoping to get onto this over the next few weeks!

@anenadic
Copy link
Contributor

anenadic commented Jan 27, 2025

Hi! Good news - we translated this lesson to the Workbench format as part of a mini-hackathon held at CarpentryConnect Heidelberg 2024.

You can see the translated lesson at: https://github.com/winfrednyoroka/machine-learning-responsible-python

There are a few next steps needed to complete the transition:

  1. Check that the translated lesson looks OK and fix any issues - or you can do that post-transition.
  2. Close any open pull requests on the lesson repository (any PRs opened or commits done since the migration in November 2024 will not end up in the translated lesson so you'd have to re-add that manually in the translated lesson)
  3. Publish your lesson to Zenodo, to create an archive of the last styles version of the site (documented at https://info.carpentries.org/resources/curriculum/lesson-release.html)
  4. Clone your “Workbenchified” fork of your lesson:
    Use git remote set-url origin <address of your original lesson repo>
    so that the changes can be pushed up to your GitHub repo
    Follow the documented workflow from point 4.3 onwards. (This assumes that you have already taken care of points 4.1 and 4.2)

Let me know if you need help.

@josenino95
Copy link

Hi @anenadic. The link you provided corresponds to another lesson, 'machine-learning-responsible-python', while the one in this repo is 'machine-learning-novice-python'. By any chance did you also translate this lesson in the mini-hackaton?

@josenino95
Copy link

Just in case, here is a translated version of the machine-learning-novice-python lesson https://github.com/UCSBCarpentry/machine-learning-novice-python

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants