Allow setting a custom Carpentry type #585
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Allow setting a custom value for the
carpentry
field in theconfig.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 thewhich_caprentry()
andwhich_icon_carpentry()
functions so that it can pick up the alternative logos fromvarnish
.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 thecarpentry
name. So this omits the need to fork{sandpaper}
, only{varnish}
needs to be forked.