Improve instructions for creating SSH key
The page https://open.win.ox.ac.uk/pages/open-science/community/Open-WIN-Community/docs/gitlab/2-1-starting-gitlab-account/ contains a description for obtaining the SSH key for setting up a Gitlab repository. In the description, there is a link to an IT website that contains a list of steps to follow. In our case, only one of the steps is needed, which is confusing for users.
When creating an SSH key for the local computer (as indicated in the “Creating a key” section in this link https://sharepoint.nexus.ox.ac.uk/sites/NDCN/FMRIB/IT/User Guides/SSH.aspx#title11), only need to run $ ssh-keygen -t rsa. Ignore the instructions after “To transfer the public key, use scp…”
Proposed solution:
-
Update the instructions to include only the relevant line that needs to be run in the command window ($ ssh-keygen -t rsa), -
link to the IT webpage by saying that more information can be found there (https://sharepoint.nexus.ox.ac.uk/sites/NDCN/FMRIB/IT/User%20Guides/Git.aspx). -
review the instructions for adding the SSH key to the profile settings