Allow setting a custom Carpentry type

[milanmlft]

Allow setting a custom value for the carpentry field in the config.yaml of a lesson.

At the moment, if a user wants to create a course website using the Carpentries workbench but with custom styling and logos, they would have to clone both the {sandpaper} and {varnish} repos:

• {varnish} to modify the styling and add custom logos
• {sandpaper} to modify the which_caprentry() and which_icon_carpentry() functions so that it can pick up the alternative logos from varnish.

See for example https://github.com/HealthBioscienceIDEAS/microscopy-novice, which uses the HealthBioscienceIDEAS/sandpaper and HealthBioscienceIDEAS/varnish forks.

This is rather cumbersome, as one needs to clone the entire {sandpaper} repo and then keep maintained, just to modify two lines of code.

With this PR, a user can use any value in the carpentry: config field and it will be picked up by {sandpaper} and used to get the matching logo from {varnish}, as long as there are logo files present in the {varnish} fork being used that (exactly) match the carpentry name. So this omits the need to fork {sandpaper}, only {varnish} needs to be forked.

[tobyhodges]

This looks good to me, thank you @milanmlft. @froggleston @ErinBecker do you think we should add a test to ensure that the newly-defined default is being captured?

[tobyhodges]

@milanmlft a new release of sandpaper will be made soon, and we plan to review this one for inclusion in the next release after that. Thanks for your patience!

[ErinBecker]

This is great @milanmlft! I've done some testing and was able to get this to work with a couple of different "logo" files (screenshots below).

I've put in a PR with an update to the documentation for this feature: carpentries/sandpaper-docs#197 and will wait to merge this PR in until that documentation has been reviewed.

[milanmlft]

I think this should do it. Let me know if it needs some more documentation or testing!

[ErinBecker]

Thanks @milanmlft for making those updates so quickly! And thank you @tobyhodges and @froggleston for noticing this issue and suggesting a fix. I've tested to confirm that adding "carpentry_description" overrides the default alt text for the logo file (screenshots below). I've also made updates to carpentries/sandpaper-docs#197 to capture these changes.

[tobyhodges]

Thanks @milanmlft, I really appreciate your quick and thoughtful responses to feedback, and of course the effort you put in to make the contribution.

@ErinBecker and @froggleston I'm happy if you're happy!

[milanmlft]

@ErinBecker @froggleston any updates on this? Thanks!

[froggleston]

Hi @milanmlft - as we're running on low capacity in the Core Team, we try hard to make, review and merge in updates when we can. Be sure we will get to this when we're able! As this is looking fairly complete, I would presume this would be in the next sandpaper release, which may be next week or the week after.

[froggleston]

LGTM! 👍