search

carpentries-incubator / R-archaeology-lesson

Data Analysis and Visualization in R for Archaologists, modified from the Data Carpentry R Workshop for Ecologists. Course site at https://carpentries-incubator.github.io/R-archaeology-lesson/
https://carpentries-incubator.github.io/R-archaeology-lesson/
Other
3 stars 1 forks source link

Use carpentries incubator styling #4

Open alisonrclarke opened 2 years ago

alisonrclarke commented 2 years ago

From carpentries-incubator/proposals#128:

@tobyhodges said:

Ideally, lessons in the Incubator should use the Incubator styling (see https://carpentries-incubator.github.io/jekyll-pages-novice/ for example), to help visitors recognise that they are not an official Carpentries lesson. Making this change is slightly more fiddly from the Data Carpentry R lesson template your repository is based on, and I can offer you two options:

You could transfer the current repository "as is" and modify the configuration and organisation of the repository to use the Incubator styling. You could do this on your own or, if you prefer, I can open a pull request to take care of this for you. The advantage to this approach is that you will keep the commit history of your project up to this point. The disadvantage is that the history will be potentially confusing because the structure of the repository will change quite a lot as a result of this change.

tobyhodges commented 2 years ago

HI @alisonrclarke I spent some time trying to convert the R-ecology template to the standard Incubator styling. My first time, and it turned out to be more complicated than I anticipated! 😆 I would like to suggest an alternative: that you migrate this lesson to use The Carpentries Workbench, our all-new lesson infrastructure that is currently entering beta tests.

Rather than try to describe what this change would involve, I think it will be easier for me to link to an example of the R-ecology lesson, converted to use the Workbench. You can expect your lesson to look similar, and the repository to be organised similarly, to that lesson. (Note that the linked lesson includes some changes and reorganisation of the current version of DC R-ecology.) The main difference would be that your lesson website would display the Incubator egg logo rather than the Data Carpentry branding.

If you are ok with making this transition, I believe @zkamvar will be able to help you by running a script to automatically convert your repository to use the Workbench. The source RMarkdown files should remain pretty recognisable to you after the switch - but I do recommend checking out the source Rmds of the example lesson I linked above.

alisonrclarke commented 2 years ago

Thanks @tobyhodges. The Workbench course looks good to me! @zkamvar if you're able to help out that would be great - I've just taken a look at https://github.com/data-lessons/lesson-transition/ but would appreciate some pointers. (I won't be around for the next week or so after today though so apologies in advance for for slow response.)

zkamvar commented 2 years ago

Thanks @tobyhodges. The Workbench course looks good to me! @zkamvar if you're able to help out that would be great - I've just taken a look at https://github.com/data-lessons/lesson-transition/ but would appreciate some pointers. (I won't be around for the next week or so after today though so apologies in advance for for slow response.)

I can definitely set aside some time to help. The transition script as it stands currently creates a mirrored snapshot for the pre-beta phase, but I am going to spend some time next week working it to perform the full beta transition (as I've outlined in the beta phase blog post).

Since you will be working with The Workbench in its beta phase, I would encourage you to head over to https://github.com/carpentries/workbench/discussions/1 and say hello 👋🏼

What I'm going to to for your lesson is similar to what is outlined in the adding a new lesson section:

  1. I'm going to copy datacarpentry/R-ecology-lesson.R to carpentries-incubator/R-archaeology-lesson.R
  2. Because the R ecology lesson does not inherit any of the traits from the styles lessons, it needs to be processed entirely from its transformation file, so I'm going to modify filter-and-transform.sh to call that file directly.
  3. I'll run the transition and host it on fishtree-attempt. If it looks good to you, then I will make the transition in this repository.

Please note that the transition rewrites history to clean up any files that are not specific to the lesson source contents. This means generated figures and detritus from files such as JavaScript, HTML, and CSS that would otherwise be provided by a template, so if you experience issues pulling the repository to your own machine, the solution is to delete it from your machine and re-clone from GitHub.

zkamvar commented 2 years ago

Hi I'm sorry for the delay on this. I have been swamped with quite a few things. Would it work for you for me to make the transition of this next week?

alisonrclarke commented 2 years ago

Please don't worry - I've been really busy myself so haven't had much chance think about this! Next week would be brilliant if you have time - thank you.

alisonrclarke commented 2 years ago

(Or this week now, I guess!)

zkamvar commented 2 years ago

I'm sorry, but something has come up and I'm going to have to push this back: https://github.com/carpentries/workbench/discussions/22

alisonrclarke commented 2 years ago

Thanks for the update - no worries.