swcarpentry / python-novice-gapminder

Plotting and Programming in Python
http://swcarpentry.github.io/python-novice-gapminder/
Other
162 stars 428 forks source link

Transition To Workbench in May #632

Closed zkamvar closed 1 year ago

zkamvar commented 1 year ago

@swcarpentry/python-novice-gapminder-maintainers

As I hope you are already aware, we are rolling 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 in the coming days.

You can follow the transition of this lesson repository at https://github.com/carpentries/lesson-transition/issues/77.

The transition has already taken place for several lessons, and so far the process has been running quite smoothly. You should see the transition take place with minimal disruption, but there are a few things that it is important for Maintainers to be aware of.

Here is what you can expect to happen next:

  1. Any open pull requests on the repository will be closed with an automated message.
  2. The repository will be set to read-only mode for a brief period while the transition occurs.
  3. The new repository structure and lesson site layout will then be applied.
  4. To avoid anyone accidentally pushing the old commit history back to the repository, after the transition Maintainers will need to delete and replace any existing forks and local clones they have of the lesson repository, and confirm that they have done so by replying to this issue.

I will reply here before and after the transition has taken place. If you have any questions in the meantime, please reach out to the Curriculum Team by tagging us here, e.g. @swcarpentry/core-team-curriculum.

If you would like to read more about the new lesson infrastructure and the modified repository structure you can expect post-transition, I recommend the Infrastructure episode of the Maintainer Onboarding curriculum and the Workbench Transition Guide, which includes a side-by-side comparison of various elements of the old and new infrastructures.

zkamvar commented 1 year ago

Hello maintainers, one thing I notice in The previewe version of the Lesson Design page (from _extras/design.md) is that there are episode links that are no longer valid (see the missing files listed in https://github.com/carpentries/lesson-transition/issues/77). I can go in and fix these, but I'm wondering if I should just leave these links alone given that the file is out of sync with the lesson and has not been updated in 3 years.

zkamvar commented 1 year ago

(Note: I just rebuilt the preview, so the link may not be active for another couple of minutes)

alee commented 1 year ago

Thanks for catching that @zkamvar! I'd vote to leave those alone and we can address them in a separate issue / PR after the workbench transition, don't want to add to your burdens.

zkamvar commented 1 year ago

We are all set to transition this lesson tomorrow. I have fixed all the issues that were identified and you can see the preview here: https://fishtree-attempt.github.io/python-novice-gapminder/

alee commented 1 year ago

The landing page has this include still sitting around, I assume it should be removed?

{% include gh_variables.html %}

image

zkamvar commented 1 year ago

Good catch! yes, if it's not gone by the time I do the transition today (which is to say I will remove it), it will need to be removed.

zkamvar commented 1 year ago

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 commented 1 year ago

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!

zkamvar commented 1 year ago

The Workbench version is now live: https://swcarpentry.github.io/python-novice-gapminder/

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

alee commented 1 year ago

Thanks @zkamvar! Looks great. I've re-forked the repo and reset my local git repo to upstream/main

Are there any plans for Docker support to render content locally? I'd be happy to contribute to https://github.com/carpentries/workbench/issues/39 if help is still needed there, I'm pretty comfortable with Docker / docker compose / etc

I am ready for write access :rocket:

zkamvar commented 1 year ago

@alee, you now have regained write access 🎉

Are there any plans for Docker support to render content locally? I'd be happy to contribute to https://github.com/carpentries/workbench/issues/39 if help is still needed there, I'm pretty comfortable with Docker / docker compose / etc

Yes, there is still need for this. With the transition, my backlog is growing and I unfortunately do not have the capacity for exploring it until later this quarter.

vahtras commented 1 year ago

I am ready for write access :rocket:

On Tue, May 2, 2023 at 11:00 PM Zhian N. Kamvar @.***> wrote:

@alee https://github.com/alee, you now have regained write access 🎉

Are there any plans for Docker support to render content locally? I'd be happy to contribute to carpentries/workbench#39 https://github.com/carpentries/workbench/issues/39 if help is still needed there, I'm pretty comfortable with Docker / docker compose / etc

Yes, there is still need for this. With the transition, my backlog is growing and I unfortunately do not have the capacity for exploring it until later this quarter.

— Reply to this email directly, view it on GitHub https://github.com/swcarpentry/python-novice-gapminder/issues/632#issuecomment-1532143644, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABLLJBI6MJYDWCY32MC4L6LXEFYWLANCNFSM6AAAAAAXLMKBHI . You are receiving this because you were mentioned.Message ID: @.***>

zkamvar commented 1 year ago

@vahtras you now have write access!

souravsingh commented 1 year ago

I am ready for write access :rocket:

zkamvar commented 1 year ago

@souravsingh access granted!

martinosorb commented 1 year ago

I am ready for write access :rocket: Thanks

zkamvar commented 1 year ago

@martinosorb, access granted!

All maintainers on this lesson now have access!