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

Migration of lesson overview pages to The Carpentries Workbench #54

Closed
ErinBecker opened this issue Aug 31, 2023 · 10 comments
Closed

Migration of lesson overview pages to The Carpentries Workbench #54

ErinBecker opened this issue Aug 31, 2023 · 10 comments
Assignees
Labels
status:in progress Contributor working on issue

Comments

@ErinBecker
Copy link

Hi @librarycarpentry/lc-overview-maintainers (and ccing @chennesy as this is relevant to #49 (comment))

The Curriculum Team is preparing to transition all of the workshop/curriculum overview sites to the Workbench. @zkamvar has set a tentative migration date of Monday 18th September. This change will bring the overview sites back in line with all of the official lessons that were transitioned to the new infrastructure in May.

We plan to include this lc-overview repository in that transition and, when we discussed this recently, @tobyhodges mentioned that you might want to wait while you remove and relocate episode files in the site. In #49 you mention that this will be discussed at the LC-CAC meeting on 21st September. Would you like to postpone the lc-overview transition until after that meeting, and if so, can you already estimate when would be a good date for the transition?

Here are a few things to consider:

  1. Here is the work-in-progress preview of what the site will look like post-transition: https://fishtree-attempt.github.io/lc-overview/index.html
  2. The transition will be quick but irreversible. Any open pull requests will be invalidated by the change (at the moment there are none).
  3. Because it contains episode files, if lc-overview is migrated to the Workbench now it will be treated as a normal lesson. A defining feature of the other curriculum overview sites is their lack of episodes: these other overview sites will not include the navigation sidebar you see in the lc-overview preview. It will be easy to adjust the lc-overview site to remove the sidebar later, if and when all episode files are removed.
  4. One implication the transition would have for the changes proposed by @emcaulay in Overview check-in #49 is that the Markdown syntax and structure of episode files is different between the old and new infrastructures. This will make it more difficult to copy episodes wholesale from a transitioned lc-overview site to any lessons that are still using the old infrastructure, e.g. "Filenaming and formatting" to the Foundational Computing Skills lesson in the Incubator. On the other hand, it will make it easier to move Jargon Busting into LC Tidy Data, which has already been transitioned to the Workbench.
@chennesy
Copy link

chennesy commented Sep 1, 2023

Thanks @ErinBecker and @tobyhodges !

Happy to follow input from @LibraryCarpentry/lc-overview-maintainers or @LibraryCarpentry/curriculum-advisors on this. But from what you outlined, it sounds like it would make sense for @zkamvar to go ahead an include the lc-overview lesson in the scheduled workbench migration on Sept 18. We can do any clean up work on the lesson following LC-CAC's Sept 21 meeting on the new workbench.

I'll download the current lc-overview repo so that we have copies of episode files with the original markdown to make the process of moving them into any Incubator lessons with the old infrastructure that much easier. But otherwise, I think having the lesson on the new workbench will help clarify exactly how we want to implement any changes that LC-CAC approves.

p.s. The https://fishtree-attempt.github.io/ preview links aren't working on my end.

@zkamvar
Copy link
Contributor

zkamvar commented Sep 1, 2023

p.s. The https://fishtree-attempt.github.io/ preview links aren't working on my end.

My bad. I had reset those previews yesterday, but forgot to ensure that the builds actuall ran. I've restarted the build and it should be up in a few minutes.

@emcaulay
Copy link
Contributor

emcaulay commented Sep 1, 2023

Just wanted to reply and say that I have read the discussion above. I will follow @chennesy 's lead on this, but I am committed to completing the work outlined in #49.

@morskyjezek
Copy link
Contributor

This sounds good. I helped with the conversion of the spreadsheets lesson to the new format and happy to do any additional support here for the overview. As I see it, the very important revisions, which @emcaulay and @chennesy have already outlined also need to happen, and will also follow their lead on this.

@zkamvar
Copy link
Contributor

zkamvar commented Sep 18, 2023

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 Sep 18, 2023

The Workbench version is now live: https://librarycarpentry.github.io/lc-overview/

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

@emcaulay emcaulay self-assigned this Oct 12, 2023
@emcaulay emcaulay added the status:in progress Contributor working on issue label Oct 12, 2023
@emcaulay
Copy link
Contributor

I am ready for write access 🚀

@tobyhodges
Copy link
Member

Thanks @emcaulay I have restored your access

@emcaulay
Copy link
Contributor

Thank you so much!! Back in action!

@ErinBecker
Copy link
Author

Hi @r2c0der - You no longer have Maintainer access to this repository. Please see the comment above for details. If you would like to restore your access, please re-clone the repository on your machine and then comment here with I am ready for write access 🚀 and the admin maintainer of this repository will restore your permissions. If you have any questions, please don’t hesitate to get in touch curriculum@carpentries.org

To the remaining Maintainers for this lesson - the Curriculum Team will be prioritizing onboarding of new Maintainers for lessons that have lost Maintainers in our next round of onboarding. Please don’t hesitate to reach out if your lesson needs additional support in the meantime - curriculum@carpentries.org.

I will close this issue now but will still be notified of any replies on the thread in future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:in progress Contributor working on issue
Projects
None yet
Development

No branches or pull requests

6 participants