Add documentation episode

[svenvanderburg]

Fixes esciencecenter-digital-skills/good-practices-in-research-software-development#40

[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/esciencecenter-digital-skills/good-practices-lesson/compare/md-outputs..md-outputs-PR-3

The following changes were observed in the rendered markdown documents:

 2-documentation.md (new) | 247 +++++++++++++++++++++++++++++++++++++++++++++++
 config.yaml              |   1 +
 md5sum.txt               |   3 +-
 3 files changed, 250 insertions(+), 1 deletion(-)

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-06-03 14:51:28 +0000

[lyashevska]

Thanks @svenvanderburg. Looks great. Can you please check the following GitHub Actions messages:
[missing file]: PyTest
[image missing alt-text]: fig/ci-python-application-workflow.png and
[image missing alt-text]: fig/ci-tests-succeed-screenshot.png

[svenvanderburg]

@lyashevska yes, there are indeed missing alt-texts. But since this lesson material is only for internal use I think we don't really care about those details.