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

Fix report reference #1766

Merged
merged 3 commits into from
Dec 14, 2024
Merged

Fix report reference #1766

merged 3 commits into from
Dec 14, 2024

Conversation

julia-sprenger
Copy link
Contributor

Fix broken link in learner/setup.md

Copy link

github-actions bot commented Dec 9, 2024

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/instructor-training/compare/md-outputs..md-outputs-PR-1766

The following changes were observed in the rendered markdown documents:

 checkout.md | 4 ++--
 md5sum.txt  | 4 ++--
 setup.md    | 2 +-
 3 files changed, 5 insertions(+), 5 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-12-14 19:46:18 +0000

learners/setup.md Outdated Show resolved Hide resolved
@brownsarahm
Copy link
Contributor

@maneesha and @carpentries/instructor-training-maintainers we should merge this quickly because it's a broken link, but I wanted to check if this suggestion per #1755 is well-phrased

@maneesha
Copy link
Contributor

maneesha commented Dec 9, 2024

As I noted in #1755, yes, we should refer to the "most recent" annual report. That way we do not have to update it every year, and it's clear to the trainee that they only have to read that one, not everything.

@brownsarahm
Copy link
Contributor

thanks @julia-sprenger for improving the PR and submitting it! I'm going to merge this now, but not close the related issue because it points to an additional location we should fix.

github-actions bot pushed a commit that referenced this pull request Dec 14, 2024
@brownsarahm brownsarahm merged commit 5c439dc into carpentries:main Dec 14, 2024
3 checks passed
github-actions bot pushed a commit that referenced this pull request Dec 14, 2024
Auto-generated via `{sandpaper}`
Source  : 5c439dc
Branch  : main
Author  : Sarah Brown <brownsarahm@uri.edu>
Time    : 2024-12-14 19:50:07 +0000
Message : Merge pull request #1766 from julia-sprenger/patch-1

Fix report reference
github-actions bot pushed a commit that referenced this pull request Dec 14, 2024
Auto-generated via `{sandpaper}`
Source  : 907c41a
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-12-14 19:50:56 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 5c439dc
Branch  : main
Author  : Sarah Brown <brownsarahm@uri.edu>
Time    : 2024-12-14 19:50:07 +0000
Message : Merge pull request #1766 from julia-sprenger/patch-1

Fix report reference
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants