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

Directions for creating a new SSH key are inconsistent and fail if run as documented #1086

Closed
DavidAnson opened this issue Nov 5, 2020 · 4 comments · May be fixed by arroselli/docs#5 or Chantall1602/docs#5
Labels
triage Do not begin working on this issue until triaged by the team

Comments

@DavidAnson
Copy link
Contributor

What article on docs.github.com is affected?

Generating a new SSH key and adding it to the ssh-agent
https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

What part(s) of the article would you like to see updated?

On Linux, the user is told:

> Enter a file in which to save the key (/home/you/.ssh/id_ed25519): [Press enter]

And:

$ ssh-add ~/.ssh/id_rsa

These are inconsistent - the file in the second case should be id_ed25519.

I'd have submitted a PR, but there's inconsistent use of {% data reusables.ssh.add-ssh-key-to-ssh-agent-commandline %} here and I don't know where that's defined.

Additional information

Results of the second command if run as documented:

pi@pi:~ $ ssh-add ~/.ssh/id_rsa
/home/pi/.ssh/id_rsa: No such file or directory
@welcome
Copy link

welcome bot commented Nov 5, 2020

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 5, 2020
@nschonni
Copy link
Contributor

nschonni commented Nov 5, 2020

There are 2 pending PRs to fix it #1074 and #1063

@airairair20

This comment has been minimized.

@shelbiiii shelbiiii mentioned this issue Nov 15, 2020
@shati-patel
Copy link
Contributor

Thank you for reporting the bug and helping us improve our docs, @DavidAnson! 🎉

This has now been fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage Do not begin working on this issue until triaged by the team
Projects
None yet
6 participants
@nschonni @DavidAnson @shati-patel @airairair20 and others