Use of remote_theme

[rgaiacs]

@dpshelio asked to prototype using https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/ to "simplify" the building process.

[dpshelio]

In my free time -- which is scarce -- I'm looking into that. I'll add here any updates.

[dpshelio]

All right! it's done and it's super nice!!!

So, I've replicated swcarpentry organisation in a different github-org, and it works! Check the following

• The theme is under carpentry-theme
  • The differences as a PR: Changes to create styles into a theme carpentries-i18n/carpentry-theme#3
• The shell-novice lesson rendered by that theme.
  • The cleaner repository
  • The differences as a PR: New Crowdin updates swcarpentry-i18n/shell-novice#1

I think on the way I've also got two fixes!!!

• favicon now appears!! (left origina/right using theme)
  

• left edge on bash code appears now with colour (the python lesson doesn't have that problem)
  

I've also removed all the bin directory for this example. I would say that the bin directory could be provided to the lessons maintainers as a git-submodule in the same fashion that astropy does with their astropy-helpers. Keeping it on the same line, we could call it carpentries-helpers.

[rgaiacs]

@dpshelio Thanks very much.

@fmichonneau Could you add this to be discussed on the 23 May meeting?

[klieret]

Hi @dpshelio @rgaiacs @fmichonneau . I'm curious about this change. Was there any specific reason you decided against this? This seems to be a very elegant solution for sharing common parts of code between the different repositories.

I'm part of an organization (HSF Training) that develops training modules based on your template (thank you! ❤️) for the high energy physics community and we have been recently discussing this exact change (here), because the number of our repositories continues to increase.

We'd be very happy to hear about your 2021 opinion on this :)

[maxim-belkin]

@klieret, check out carpentries/carpentries-theme repo

[klieret]

Thanks a lot @maxim-belkin Exactly what we were looking for! I'm just curious that both styles and carpentries-theme currently coexist (and seem to be maintained somewhat separately). Why don't you simply remove all style files form styles and instead add carpentries-theme to its Gemfile?

[fmichonneau]

Hi @klieret

We have both because we have many lessons that use and rely on styles, and the remote theme doesn't allow us to have other scripts our infrastructure needs (e.g., scripts run by make lesson-check).

All the commits in styles that affect the remote theme are synchronized regularly.

As a side-note, we are working on the next iteration of our lesson template which is designed to better compartmentalize styling, building, and checking.

Thanks!