summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJob van der Voort <job@gitlab.com>2015-09-24 08:48:46 +0000
committerJob van der Voort <job@gitlab.com>2015-09-24 08:48:46 +0000
commit827367ead7e2f7045e9ac01fafc396468fd46c11 (patch)
treeb89f7d716daddccd1b0e6d91736f62eeea6609fc
parenta58c6e9a9561ffbb3d16a3a9a45bd90a34735b50 (diff)
parentcfcb5f0f6aac821ad5367645c994fbf7b8f41ea2 (diff)
downloadgitlab-ce-827367ead7e2f7045e9ac01fafc396468fd46c11.tar.gz
Merge branch 'sshpage-fix' into 'master'
Made some steps to add SSH keys more clear See merge request !1936
-rw-r--r--doc/gitlab-basics/create-your-ssh-keys.md6
-rw-r--r--doc/ssh/README.md26
2 files changed, 14 insertions, 18 deletions
diff --git a/doc/gitlab-basics/create-your-ssh-keys.md b/doc/gitlab-basics/create-your-ssh-keys.md
index c8a73feb028..f31c353f2cf 100644
--- a/doc/gitlab-basics/create-your-ssh-keys.md
+++ b/doc/gitlab-basics/create-your-ssh-keys.md
@@ -10,11 +10,7 @@ After you confirm, go to GitLab and sign in to your account.
## Add your SSH Key
-At the top right corner, click on "profile settings":
-
-![profile settings](basicsimages/profile_settings.png)
-
-On the left side menu click on "SSH Keys":
+On the left side menu, click on "profile settings" and then click on "SSH Keys":
![SSH Keys](basicsimages/shh_keys.png)
diff --git a/doc/ssh/README.md b/doc/ssh/README.md
index 7b294a70fe7..b6b8000af4e 100644
--- a/doc/ssh/README.md
+++ b/doc/ssh/README.md
@@ -3,27 +3,27 @@
## SSH keys
An SSH key allows you to establish a secure connection between your
-computer and GitLab.
+computer and GitLab. Before generating an SSH key in your shell, check if your system
+already has one by running the following command:
+```bash
+cat ~/.ssh/id_rsa.pub
+```
-Before generating an SSH key, check if your system already has one by
-running `cat ~/.ssh/id_rsa.pub`. If you see a long string starting with
-`ssh-rsa` or `ssh-dsa`, you can skip the ssh-keygen step.
+If you see a long string starting with `ssh-rsa` or `ssh-dsa`, you can skip the `ssh-keygen` step.
-To generate a new SSH key, just open your terminal and use code below. The
-ssh-keygen command prompts you for a location and filename to store the key
-pair and for a password. When prompted for the location and filename, you
-can press enter to use the default.
-
-It is a best practice to use a password for an SSH key, but it is not
+Note: It is a best practice to use a password for an SSH key, but it is not
required and you can skip creating a password by pressing enter. Note that
the password you choose here can't be altered or retrieved.
+To generate a new SSH key, use the following command:
```bash
ssh-keygen -t rsa -C "$your_email"
```
+This command will prompt you for a location and filename to store the key
+pair and for a password. When prompted for the location and filename, you
+can press enter to use the default.
-Use the code below to show your public key.
-
+Use the command below to show your public key:
```bash
cat ~/.ssh/id_rsa.pub
```
@@ -32,7 +32,7 @@ Copy-paste the key to the 'My SSH Keys' section under the 'SSH' tab in your
user profile. Please copy the complete key starting with `ssh-` and ending
with your username and host.
-Use code below to copy your public key to the clipboard. Depending on your
+To copy your public key to the clipboard, use code below. Depending on your
OS you'll need to use a different command:
**Windows:**