Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write instructions for lesson setup #21

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Write instructions for lesson setup #21

wants to merge 3 commits into from

Conversation

e-belfer
Copy link
Member

Overview

Closes #19.

What problem does this address?
Help learners set up everything they need before the lesson starts.

What did you change in this PR?
Update setup.md.

Testing

How did you make sure this worked? How can a reviewer verify this?

To-do list

Tasks

Preview Give feedback

@e-belfer e-belfer added the setup Concerning lesson setup instructions or requirements. label Jan 30, 2025
@e-belfer e-belfer self-assigned this Jan 30, 2025
Copy link

github-actions bot commented Jan 30, 2025

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/catalyst-cooperative/open-energy-data-for-all/compare/md-outputs..md-outputs-PR-21

The following changes were observed in the rendered markdown documents:

 config.yaml         |   1 +
 md5sum.txt          |   5 +-
 reference.md (gone) |   8 --
 setup.md            | 244 +++++++++++++++++++++++++++++++++++++++++++++-------
 4 files changed, 218 insertions(+), 40 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 2025-01-30 16:43:51 +0000

github-actions bot pushed a commit that referenced this pull request Jan 30, 2025
github-actions bot pushed a commit that referenced this pull request Jan 30, 2025
github-actions bot pushed a commit that referenced this pull request Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
setup Concerning lesson setup instructions or requirements.
Projects
Status: New
Development

Successfully merging this pull request may close these issues.

Write lesson setup instructions
1 participant