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 repo links in index #243

Merged
merged 1 commit into from
Aug 16, 2024

Conversation

jcohen02
Copy link
Contributor

@jcohen02 jcohen02 commented Aug 2, 2024

I wasn't sure if these links were left incomplete intentionally (i.e. because individuals should update them with the relevant links when they create a fork?) however, I decided it made sense to have these set to the correct locations for the reference repository.

Feel free to reject this PR if things were set up like this intentionally.

@jcohen02 jcohen02 requested a review from aturner-epcc August 2, 2024 11:34
Copy link

github-actions bot commented Aug 2, 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-incubator/docker-introduction/compare/md-outputs..md-outputs-PR-243

The following changes were observed in the rendered markdown documents:

 creating-container-images.md | 5 ++++-
 md5sum.txt                   | 4 ++--
 2 files changed, 6 insertions(+), 3 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-08-04 20:26:59 +0000

github-actions bot pushed a commit that referenced this pull request Aug 2, 2024
@jcohen02
Copy link
Contributor Author

jcohen02 commented Aug 2, 2024

I'm not sure what's going on here but I note that the links I've replaced here are actually defined in _includes/links.md but for some reason they're not being rendered on my local deployment - I think this PR may be redundant....

github-actions bot pushed a commit that referenced this pull request Aug 4, 2024
@jcohen02
Copy link
Contributor Author

jcohen02 commented Aug 4, 2024

An update on the previous comment - it looks like the _includes directory is probably a left-over from the previous Jekyll template that this lesson was using. Moving links.md to the top level of the repo as noted in the docs solves the problem and global "named" links in this file are now visible across lesson files.

There was also an error being generated with the link [R] in the advanced containers episode - links with a single character are not valid. This has been resolved by instead referring to the "R programming language".

Copy link
Contributor

@aturner-epcc aturner-epcc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@aturner-epcc aturner-epcc merged commit e631501 into carpentries-incubator:main Aug 16, 2024
3 checks passed
github-actions bot pushed a commit that referenced this pull request Aug 16, 2024
Auto-generated via {sandpaper}
Source  : e631501
Branch  : main
Author  : Andy Turner <[email protected]>
Time    : 2024-08-16 08:19:26 +0000
Message : Merge pull request #243 from jcohen02/fix/repo_links

Fix repo links in index
github-actions bot pushed a commit that referenced this pull request Aug 16, 2024
Auto-generated via {sandpaper}
Source  : 402b978
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-08-16 08:20:16 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : e631501
Branch  : main
Author  : Andy Turner <[email protected]>
Time    : 2024-08-16 08:19:26 +0000
Message : Merge pull request #243 from jcohen02/fix/repo_links

Fix repo links in index
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.

2 participants