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

Include reference to git installation from chapter 2 #977

Merged
merged 2 commits into from
Nov 20, 2023

Conversation

unode
Copy link
Contributor

@unode unode commented Nov 14, 2023

For any reader/learner that may have missed the Summary and Setup section of the lesson, gently guide them to the corresponding page and the installation instructions section before introducing any command.

This PR adds a callout and link to the git installation section just before the first git command in chapter 2.

Click here for a preview of the change

Copy link

github-actions bot commented Nov 14, 2023

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/swcarpentry/git-novice/compare/md-outputs..md-outputs-PR-977

The following changes were observed in the rendered markdown documents:

 02-setup.md | 9 +++++++++
 md5sum.txt  | 2 +-
 2 files changed, 10 insertions(+), 1 deletion(-)
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-11-20 17:02:25 +0000

@martinosorb martinosorb merged commit 602843c into swcarpentry:main Nov 20, 2023
3 checks passed
github-actions bot pushed a commit that referenced this pull request Nov 20, 2023
@martinosorb
Copy link
Contributor

Sounds very reasonable and I don't see why we shouldn't include it. Thanks for the PR!

github-actions bot pushed a commit that referenced this pull request Nov 20, 2023
Auto-generated via {sandpaper}
Source  : 602843c
Branch  : main
Author  : Martino Sorbaro <[email protected]>
Time    : 2023-11-20 17:02:59 +0000
Message : Merge pull request #977 from unode/patch-1

Include reference to git installation from chapter 2
github-actions bot pushed a commit that referenced this pull request Nov 20, 2023
Auto-generated via {sandpaper}
Source  : 5da8156
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-11-20 17:03:58 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 602843c
Branch  : main
Author  : Martino Sorbaro <[email protected]>
Time    : 2023-11-20 17:02:59 +0000
Message : Merge pull request #977 from unode/patch-1

Include reference to git installation from chapter 2
@martinosorb
Copy link
Contributor

For reference -- this merge has been reverted due to lack of agreement among maintainers.

@unode
Copy link
Contributor Author

unode commented Nov 21, 2023

Can a case still be made to have a reference to the setup in some form in this chapter?

The main motivation is to guide self-learners.

As the opening text in the lesson reads like a fiction work, we have noticed that learners often skip it, arriving to the first command without having git correctly installed.

An alternative to the callout proposed, could be to provide a some info to troubleshoot the eventual git: command not found error if installation wasn't done or was incomplete (e.g. git not added to PATH).
This was the error most learners that skipped the setup ran into. Most of them were still able to launch a command-line (cmd.exe on Windows and Terminal in Mac/Linux).

@kekoziar
Copy link
Contributor

@unode While many Carpentries lessons can be used for self-learning, at their core, they are still designed to be led by a knowledgeable instructor. We have to be careful with scope creep, and self-learners vs a workshop lesson is one of the areas which we need to be careful about. If we imagined all of the scenarios where self-learners may need assistance, it would be a very different (and large) lesson.

That said, there is an approved solution that checks if learners (self or workshop) have installed git, by introducing git status at the beginning. It's referenced in this issue.

Feel free to include a PR with the proposed solution, or if you want we can workshop the wording here or in the original issue.

@unode
Copy link
Contributor Author

unode commented Nov 21, 2023

I'm not sure I follow the scope creep argument for such a small suggestion, nor the self-learn one which I believe has always been part of many of the lessons. So much so that the carpentry workbench includes both a learner and an instructor view. Looking at it from that angle, if to be lead by experienced instructors, there's a lot of prose that could potentially be cut...

But that aside, I will provide my feedback in the other issue to keep the discussion on thread.

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