Skip to content

Refactor the SSH keys docs

Problem

User struggled to locate the command for copying an existing SSH key within the SSH instructions (https://gitlab.com/help/ssh/README). User did not look under 'Generating a new SSH key pair' as he already had an existing key and did not think the information contained in this section was relevant/useful to him.

This problem was identified as part of the following research study: ux-research#53 (closed)

Recommendations

  • Add skip links for each heading via a "On this page" table of content.

  • Create a new heading 'Adding a SSH key to your GitLab account'. Move steps 4-6 from 'Generating a new SSH key pair' to 'Adding a SSH key to your GitLab account'.

    • "4. The next step is to copy the public SSH key as we will need it afterwards."
    • "5. The final step is to add your public SSH key to GitLab."
    • "6. Optionally you can test your setup by running …"
Edited by Achilleas Pipinellis - OOO until November 25th (parental leave)