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

SSH in Beginner's Tutorial #1469

Closed
TurekBot opened this issue May 16, 2019 · 2 comments
Closed

SSH in Beginner's Tutorial #1469

TurekBot opened this issue May 16, 2019 · 2 comments

Comments

@TurekBot
Copy link
Contributor

📚 Documentation

I'm not sure what the exact problem is, but when I tried to follow the tutorial it didn't work—maybe someone wiser can tell us why.

I followed the beginner's tutorial up to the point where I created a new repository, however,
when I tried to clone that repository using the provided instructions (step 5), it failed.

C:\Users\BradTurek\IdeaProjects>git clone git@github.com:TurekBot/docusaurus-tut
orial.git
Cloning into 'docusaurus-tutorial'...
The authenticity of host 'github.com (192.30.253.112)' can't be established.
RSA key fingerprint is SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8.
Are you sure you want to continue connecting (yes/no)? y
Please type 'yes' or 'no': yes
Warning: Permanently added 'github.com,192.30.253.112' (RSA) to the list of know
n hosts.
git@github.com: Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

C:\Users\BradTurek\IdeaProjects>

My suspicion is that this is related to me never having used SSH, but I couldn't tell you for sure.

What I do know is that when I used HTTPS instead, it did work.

C:\Users\BradTurek\IdeaProjects>git clone https://github.com/TurekBot/docusaurus
-tutorial.git
Cloning into 'docusaurus-tutorial'...
warning: You appear to have cloned an empty repository.

C:\Users\BradTurek\IdeaProjects>cd docusaurus-tutorial

C:\Users\BradTurek\IdeaProjects\docusaurus-tutorial>

Any ideas what caused SSH not to work? 🤷‍♂️ : I fear this may happen to any user who doesn't use SSH.

Have you read the Contributing Guidelines on issues?

Yes, I have.

@yangshun
Copy link
Contributor

This doesn't seem specific to Docusaurus. Have you set up your SSH key on your device?

You can follow the instructions here - https://help.github.com/en/articles/connecting-to-github-with-ssh

You could submit a PR to add additional instructions regarding SSH if you like 😄

@TurekBot
Copy link
Contributor Author

@yangshun thanks for the link about SSH. I guess I've never had to use SSH before.

Since we're instructing the user to create a new repository, it might be a safe bet to assume that they don't have their SSH keys set up.

What do you think about changing the tutorial to use HTTPS? Then we still support new users; people familiar with SSH surely already know how to clone using SSH. Does that seem like the best of both worlds?

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

No branches or pull requests

3 participants