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

2310 gitcodev fixes #15

Open
wants to merge 2 commits into
base: 2310-gitcodev-TUD
Choose a base branch
from
Open

Conversation

wmotion
Copy link
Collaborator

@wmotion wmotion commented Oct 19, 2023

This branch at the time of this message proposes corrections to Lesson3 mostly regarding the installation of an SSH-based connection. The aims are

  • to include the instructions for Windows users, who should run Git Bash as local administrators
  • to improve the readability of the procedure

The rationale of additional commits will be explained either as messages below (if differing in aims) or in the body of the commits (if in line with the above aims)

I have commented on the early steps that participants should take to get
SSH going on Git Bash, that is, run it as local administrator. As @manuGil
suggested, this has been proven to forestall a category of issues down the
line and worked for the 2310-gitcodev editions.

Added a short explanation of what a positive `ssh -T <upstream address>`
is, so as to invite participants to recognize success or failure with a
little guidance
Removed the markdown coding for shell/bash command, since indenting is
sufficient for a nice styling on GitHub and syntax highlighting is
unnecessary here. Only up to Section A.1.

Patterned paragraphs of Section A.1 as nested lists. This should make it
easier to recognize the step and substeps of the SSH-related procedure.

All document: removed trailing space, with no immediate benefit in sight.
@wmotion wmotion requested a review from manuGil October 19, 2023 11:30
@wmotion wmotion assigned wmotion and manuGil and unassigned wmotion Oct 19, 2023
@wmotion wmotion removed the request for review from manuGil October 19, 2023 11:31
@wmotion wmotion added the documentation Improvements or additions to documentation label Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants