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

Rework definitions #253

Merged

Conversation

multimeric
Copy link
Contributor

This is a large and possibly controversial change to the introduction. I felt in particular that the "What is a Container? What is Docker?" section was too long and complicated by a few concepts that weren't strictly necessary. I've simplified it in the following ways:

  • Remove paragraph about computer hardware. I didn't really see the relevance to containers, and this is a very long section that could benefit from some brevity
  • Remove paragraph about computer filesystem. As above.
  • Remove cat meme example. We actually already have some good concrete research motivations from the previous section (Scientific Software Challenges), so I don't think an artificial example is needed here
  • Separate section on docker from section on containers. This is nice natural way to split up this section and reduce cognitive load
  • Separate section on container images

Very happy to discuss this and modify it as needed.

Copy link

github-actions bot commented Sep 16, 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-253

The following changes were observed in the rendered markdown documents:

 introduction.md | 48 ++++++++++++++++++------------------------------
 md5sum.txt      |  2 +-
 2 files changed, 19 insertions(+), 31 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-09-16 07:34:40 +0000

github-actions bot pushed a commit that referenced this pull request Sep 16, 2024
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.

@multimeric Thanks for this. I think it is a definite improvement and looks good. I'll merge it now.

@aturner-epcc aturner-epcc merged commit 0c0fb63 into carpentries-incubator:main Sep 16, 2024
3 checks passed
github-actions bot pushed a commit that referenced this pull request Sep 16, 2024
Auto-generated via {sandpaper}
Source  : 0c0fb63
Branch  : main
Author  : Andy Turner <[email protected]>
Time    : 2024-09-16 17:56:07 +0000
Message : Merge pull request #253 from WEHI-Education/rework-definitions

Rework definitions
github-actions bot pushed a commit that referenced this pull request Sep 16, 2024
Auto-generated via {sandpaper}
Source  : 916103c
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-09-16 17:56:55 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0c0fb63
Branch  : main
Author  : Andy Turner <[email protected]>
Time    : 2024-09-16 17:56:07 +0000
Message : Merge pull request #253 from WEHI-Education/rework-definitions

Rework definitions
github-actions bot pushed a commit that referenced this pull request Sep 17, 2024
Auto-generated via {sandpaper}
Source  : 916103c
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-09-16 17:56:55 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0c0fb63
Branch  : main
Author  : Andy Turner <[email protected]>
Time    : 2024-09-16 17:56:07 +0000
Message : Merge pull request #253 from WEHI-Education/rework-definitions

Rework definitions
github-actions bot pushed a commit that referenced this pull request Sep 24, 2024
Auto-generated via {sandpaper}
Source  : 916103c
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-09-16 17:56:55 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0c0fb63
Branch  : main
Author  : Andy Turner <[email protected]>
Time    : 2024-09-16 17:56:07 +0000
Message : Merge pull request #253 from WEHI-Education/rework-definitions

Rework definitions
github-actions bot pushed a commit that referenced this pull request Oct 1, 2024
Auto-generated via {sandpaper}
Source  : 916103c
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-09-16 17:56:55 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0c0fb63
Branch  : main
Author  : Andy Turner <[email protected]>
Time    : 2024-09-16 17:56:07 +0000
Message : Merge pull request #253 from WEHI-Education/rework-definitions

Rework definitions
github-actions bot pushed a commit that referenced this pull request Oct 8, 2024
Auto-generated via {sandpaper}
Source  : 916103c
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-09-16 17:56:55 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0c0fb63
Branch  : main
Author  : Andy Turner <[email protected]>
Time    : 2024-09-16 17:56:07 +0000
Message : Merge pull request #253 from WEHI-Education/rework-definitions

Rework definitions
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