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

Adding your SSH key to the ssh-agent still shows "$ ssh-add ~/.ssh/id_rsa" when it should show "$ ssh-add ~/.ssh/id_ed25519" #1352

Closed
okbrown opened this issue Nov 15, 2020 · 4 comments
Labels
triage Do not begin working on this issue until triaged by the team

Comments

@okbrown
Copy link

okbrown commented Nov 15, 2020

What article on docs.github.com is affected?

Generating a new SSH key and adding it to the ssh-agent

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

Adding your SSH key to the ssh-agent

As a Linux user (have not tested to see for other OS') I see this

As you can see it states to run the command $ ssh-add ~/.ssh/id_rsa however by this point you have created a id_ed25519 ssh key so this will not work. For novices or people who like "TLDR" this will be confusing and create a bad user experience.

Additional information

I did fork the docs repo in an attempt to update it, but then I came across an unexpected element I was not aware of. The .md files use templating and inject data into the view e.g. {% data reusables.ssh.dsa-support %}.

After more digging, I found https://github.com/github/docs/blob/main/data/reusables/ssh/add-ssh-key-to-ssh-agent-commandline.md which is where it would appear its coming from.

  • I would like someone to confirm does this page toggle between different views based on operating systems ?
  • changing the above ssh agent .md file would that change it for all views?
  • just guessing here so apologies if I am wrong.

Thanks.

@welcome
Copy link

welcome bot commented Nov 15, 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 15, 2020
@janiceilene
Copy link
Contributor

👋 @okbrown I think there are a few open PRs opened about this issue that are waiting for review (https://github.com/github/docs/pulls?q=is%3Apr+is%3Aopen+ssh), so hopefully this will be fixed up soon 🤞

I would like someone to confirm does this page toggle between different views based on operating systems ?

Yep! We add tags like {% mac %} and {% endmac %} to a page to allow toggling between the different operating systems.

changing the above ssh agent .md file would that change it for all views?

It needs to be changed between each set of tags to change it for each operating system.

@punkan

This comment has been minimized.

@shati-patel
Copy link
Contributor

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

This has now been fixed.

jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this issue Oct 6, 2022
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
Development

No branches or pull requests

4 participants