document custom logo

[ErinBecker]

This PR adds documentation for how to configure your lesson to use a custom logo (other than one of The Carpentries logos that are included in the template). This should be reviewed and merged along with carpentries/sandpaper#585.

I would particularly appreciate review of the clarity of the instructions, as well as whether I've used code formatting consistently with best practices (or at least consistently with the rest of our documentation!).

[github-actions]

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

• 🎯 correct output
• 🖼️ correct figures
• ❓ new warnings
• ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/carpentries/sandpaper-docs/compare/md-outputs..md-outputs-PR-197

The following changes were observed in the rendered markdown documents:

 editing.md | 20 +++++++++++++++++++-
 md5sum.txt |  2 +-
 2 files changed, 20 insertions(+), 2 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-07-26 10:14:25 +0000

[tobyhodges]

Thanks @ErinBecker, looks good.

[tobyhodges]

I would particularly appreciate review of the clarity of the instructions, as well as whether I've used code formatting consistently with best practices (or at least consistently with the rest of our documentation!).

Prompted by this, I have taken a closer look. There is some inconsistency already in how package names, filenames, and YAML variable names are formatted across the site, but I have suggested a few changes to try to keep things roughly in line.

[tobyhodges]

adding a couple of options missing from the list. These options should also be added to the list for the carpentry option.

[tobyhodges]

Suggested change

	carpentry_description
	: (Optional) Full organisation name. Not needed when carpentry is swc, dc, lc, or cp.
	carpentry_description
	: (Optional) Full organisation name. Not needed when carpentry is swc, dc, lc, cp, incubator, or lab.

[tobyhodges]

I have adjusted the lists and will merge this now. Thanks @ErinBecker! 🙌