docs: improve wording, add SSH method #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Tlacenka
added
the
📖 documentation
3 tasks
Tlacenka
commented
Apr 23, 2024
| @@ -4,11 +4,14 @@ In this repository, various exercises for practicing Git and GitHub skills may b | |||
|
|
|||
| ## Prerequisites | |||
|
|
|||
| [Install](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) Git on your device. | |||
| 1. [Install](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) Git on your device. | |||
| 2. Create a GitHub account. | |||
There was a problem hiding this comment.
📖 Creating a GitHub account is also optional for the HTTPS method.
Suggested change
| 2. Create a GitHub account. | |
| 2. (SSH only) Create a GitHub account. |
|
|
||
| ## Setup | ||
|
|
||
| Clone this repository using [HTTPS](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls). | ||
| Download this repository using [HTTPS](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls). |
There was a problem hiding this comment.
🔡 Nitpick: The technical term is cloning.
Suggested change
| Download this repository using [HTTPS](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls). | |
| Clone this repository using [HTTPS](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls). |
|
|
||
| ## Setup | ||
|
|
||
| Clone this repository using [HTTPS](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls). | ||
| Download this repository using [HTTPS](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls). | ||
| Alternatively using [SSH](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-ssh-urls) | ||
|
|
||
| ```bash | ||
| git clone https://github.com/flowup/git-workshop.git |
There was a problem hiding this comment.
📖 Documentation structure: The link is only for HTTPS. Perhaps the HTTPS method could be in a separate h3 section, so that the differences between setup via each method are clear. What do you think?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #7
In this PR, I am expanding the main
READMEdocumentation by describing the SSH cloning method.The information was taken from the official Git documentation.