Reminder of workshop expectations

[sstevens2]

Fixes #198

[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/lesson-development-training/compare/md-outputs..md-outputs-PR-291

The following changes were observed in the rendered markdown documents:

 CODE_OF_CONDUCT.md |  1 -
 introduction.md    |  2 +-
 links.md           |  1 +
 md5sum.txt         |  8 ++++----
 reflecting.md      | 16 ++++++++++++++++
 5 files changed, 22 insertions(+), 6 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 2023-09-29 15:06:42 +0000

[sstevens2]

Fixes #198

Missed # in the last comment so it didn't link

[tobyhodges]

Thanks @sstevens2, this looks good.

Please could you move the CoC link reference to links.md, and update the link in introduction.md

lesson-development-training/episodes/introduction.md

Line 69 in 67d41db

[Code of Conduct](../CODE_OF_CONDUCT.md).

to also point at the same?

[sstevens2]

Thanks Toby! Knew there must be someway to do that but I'm always uncertain about relative links in these contexts. Appreciate the clarification.

[sstevens2]

Something I'm still unclear on, do I need to have something the references the links.md at the bottom of each page or will it know to look for links in the links.md file?

[sstevens2]

@tobyhodges Let me know if the new sets of links seems right. They should all be to the relative ../CODE_OF_CONDUCT.md through links.md

[tobyhodges]

Something I'm still unclear on, do I need to have something the references the links.md at the bottom of each page or will it know to look for links in the links.md file?

the references in links.md can be used "like magic" i.e. they are made available to all episode files automatically.

[tobyhodges]

Thanks @sstevens2 what you've done is exactly what I had in mind. I had not anticipated that it would cause a conflict due to the linkref [coc] already being used in the CODE_OF_CONDUCT.md file itself. That's leading to this warning in the lesson build:

Duplicate link reference '[coc]' at /var/folders/rj/3gf6c_l166qc7fl3z_v4pbxw0000gr/T//RtmpE3s5YD/filee4ec19c6f7b7.md line 18 column 1

I think we need to adjust the linkref in links.md to point directly to the CoC page in the handbook (https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html) and remove the reference from CODE_OF_CONDUCT.md. Sorry for the confusion: this is my fault for being too picky!

[sstevens2]

Ooo interesting! Easy fix, will fix now.

[tobyhodges]

Thanks for persevering, @sstevens2 🙌