Skip to content

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

Description

@okbrown

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    triageDo not begin working on this issue until triaged by the team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions