From b303ff2e199c40f6aca89e88e6df8388b944fbd2 Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Mon, 21 Oct 2024 11:25:43 +0200
Subject: [PATCH 01/12] Create new SSH key page for Use Git section
---
doc/topics/git/ssh_keys.md | 9 +++++++++
1 file changed, 9 insertions(+)
create mode 100644 doc/topics/git/ssh_keys.md
diff --git a/doc/topics/git/ssh_keys.md b/doc/topics/git/ssh_keys.md
new file mode 100644
index 00000000000000..ebfe8a91d95358
--- /dev/null
+++ b/doc/topics/git/ssh_keys.md
@@ -0,0 +1,9 @@
+---
+stage: Govern
+group: Authentication
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
+---
+
+DETAILS:
+**Tier:** Free, Premium, Ultimate
+**Offering:** GitLab.com, Self-managed, GitLab Dedicated
--
GitLab
From 237a310856f808bef19a23e89f15282a0ee75f1a Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Mon, 21 Oct 2024 11:26:00 +0200
Subject: [PATCH 02/12] Add introduction for new page
---
doc/topics/git/ssh_keys.md | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/doc/topics/git/ssh_keys.md b/doc/topics/git/ssh_keys.md
index ebfe8a91d95358..010609b5fc635c 100644
--- a/doc/topics/git/ssh_keys.md
+++ b/doc/topics/git/ssh_keys.md
@@ -7,3 +7,12 @@ info: To determine the technical writer assigned to the Stage/Group associated w
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab.com, Self-managed, GitLab Dedicated
+
+SSH keys provide secure communication between your computer and GitLab.
+When you use SSH keys to authenticate to the GitLab remote server,
+you don't need to supply your username and password each time.
+
+SSH uses two keys:
+
+- A public key that can be shared.
+- A private key that should be kept secure.
--
GitLab
From 7fd2c4d0139dc7a0941372f0fcfa7b6653f71ae4 Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Mon, 21 Oct 2024 11:35:02 +0200
Subject: [PATCH 03/12] Add prerequisites, supported key types, and checking
for existing keys
---
doc/topics/git/ssh_keys.md | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/doc/topics/git/ssh_keys.md b/doc/topics/git/ssh_keys.md
index 010609b5fc635c..a27c7c672a80af 100644
--- a/doc/topics/git/ssh_keys.md
+++ b/doc/topics/git/ssh_keys.md
@@ -16,3 +16,31 @@ SSH uses two keys:
- A public key that can be shared.
- A private key that should be kept secure.
+
+## Prerequisites
+
+- Git must be installed on your computer. For information on how to install Git, see [Install Git](how_to_install_git/index.md).
+- The OpenSSH client, which comes pre-installed on GNU/Linux, macOS, and Windows 10.
+- SSH version 6.5 or later. Earlier versions used an MD5 signature, which is not secure.
+
+## Supported SSH key types
+
+GitLab supports the following SSH key types:
+
+- ED25519
+- ED25519_SK
+- ECDSA_SK
+- RSA
+
+For more information on the supported SSH key types, see [SSH keys](../../user/ssh.md#supported-ssh-key-types).
+
+## Check for existing SSH keys
+
+Before generating a new SSH key pair, check if a pair already exists:
+
+```shell
+`ls -al ~/.ssh`
+```
+
+In the output, look for files named `id_ed25519.pub`,`id_rsa.pub`, or similar.
+If no file are found, proceed to generate a new key pair.
--
GitLab
From 9225cc4de5d7261e9e286868f8aea5496c2ae45f Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Mon, 21 Oct 2024 11:47:57 +0200
Subject: [PATCH 04/12] Add info on how to generate a new ssh key pair
---
doc/topics/git/ssh_keys.md | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/doc/topics/git/ssh_keys.md b/doc/topics/git/ssh_keys.md
index a27c7c672a80af..f7e07af8cfdac4 100644
--- a/doc/topics/git/ssh_keys.md
+++ b/doc/topics/git/ssh_keys.md
@@ -44,3 +44,27 @@ Before generating a new SSH key pair, check if a pair already exists:
In the output, look for files named `id_ed25519.pub`,`id_rsa.pub`, or similar.
If no file are found, proceed to generate a new key pair.
+
+## Generate a new SSH key pair
+
+To generate a new SSH key pair:
+
+1. Open a terminal.
+1. Run the `ssh-keygen -t` command and replace `<comment>` with your email address.
+
+ - Example for ED25519:
+
+ ```shell
+ ssh-keygen -t ed25519 -C "<comment>"
+ ```
+
+ - Example for 2048-bit RSA:
+
+ ```shell
+ ssh-keygen -t rsa -b 2048 -C "<comment>"
+ ```
+
+1. Press <kbd>Enter</kbd> to accept the default filename and directory, or [configure SSH to point to a different directory](../../user/ssh.md#configure-ssh-to-point-to-a-different-directory).
+1. For added security, specify a [passphrase](https://www.ssh.com/academy/ssh/passphrase).
+
+A confirmation is displayed, including information about where your files are stored.
--
GitLab
From aa502c7b3219614566c493bd1c1b0813457e425d Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Mon, 21 Oct 2024 12:05:03 +0200
Subject: [PATCH 05/12] Process steps for adding SSH key pair to GitLab
---
doc/topics/git/ssh_keys.md | 54 ++++++++++++++++++++++++++++++++++++++
1 file changed, 54 insertions(+)
diff --git a/doc/topics/git/ssh_keys.md b/doc/topics/git/ssh_keys.md
index f7e07af8cfdac4..29167ae67272a1 100644
--- a/doc/topics/git/ssh_keys.md
+++ b/doc/topics/git/ssh_keys.md
@@ -68,3 +68,57 @@ To generate a new SSH key pair:
1. For added security, specify a [passphrase](https://www.ssh.com/academy/ssh/passphrase).
A confirmation is displayed, including information about where your files are stored.
+
+## Add your SSH key to your GitLab account
+
+To use SSH with GitLab:
+
+1. Copy your public key to the clipboard. For example, to copy an ED25519 key:
+
+ ::Tabs
+
+ :::macOS
+
+ ```shell
+ tr -d '\n' < ~/.ssh/id_ed25519.pub | pbcopy
+ ```
+
+ Replace `id_ed25519.pub` with your filename.
+
+ :::Linux
+
+ Requires the `xclip` package.
+
+ ```shell
+ xclip -sel clip < ~/.ssh/id_ed25519.pub
+ ```
+
+ Replace `id_ed25519.pub` with your filename. Replace `id_ed25519.pub` with your filename.
+
+ :::Windows
+
+ Requires Git Bash.
+
+ ```shell
+ cat ~/.ssh/id_ed25519.pub | clip
+ ```
+
+ Replace `id_ed25519.pub` with your filename.
+
+ ::EndTabs
+
+1. Go to GitLab and sign in.
+1. On the left sidebar, select your avatar.
+1. Select **Edit profile**.
+1. On the left sidebar, select **SSH Keys**.
+1. Select **Add new key**.
+1. In the **Key** box, paste the contents of your public key.
+1. In the **Title** box, type a description, like `Work Laptop` or
+ `Home Workstation`.
+1. Optional. Select the **Usage type** of the key. It can be used either for `Authentication` or `Signing` or both. `Authentication & Signing` is the default value.
+1. Optional. Update **Expiration date** to modify the default expiration date.
+ - Administrators can view expiration dates and use them for
+ guidance when [deleting keys](../administration/credentials_inventory.md#delete-a-users-ssh-key).
+ - GitLab checks all SSH keys at 01:00 AM UTC every day. It emails an expiration notice for all SSH keys that are scheduled to expire seven days from now.
+ - GitLab checks all SSH keys at 02:00 AM UTC every day. It emails an expiration notice for all SSH keys that expire on the current date.
+1. Select **Add key**.
--
GitLab
From 08d62ca9e9a1ac9d45f20abcbda314fbc70a9a5d Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Mon, 21 Oct 2024 12:05:50 +0200
Subject: [PATCH 06/12] Fix reference link
---
doc/topics/git/ssh_keys.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/topics/git/ssh_keys.md b/doc/topics/git/ssh_keys.md
index 29167ae67272a1..8f1da88c1e63b7 100644
--- a/doc/topics/git/ssh_keys.md
+++ b/doc/topics/git/ssh_keys.md
@@ -118,7 +118,7 @@ To use SSH with GitLab:
1. Optional. Select the **Usage type** of the key. It can be used either for `Authentication` or `Signing` or both. `Authentication & Signing` is the default value.
1. Optional. Update **Expiration date** to modify the default expiration date.
- Administrators can view expiration dates and use them for
- guidance when [deleting keys](../administration/credentials_inventory.md#delete-a-users-ssh-key).
+ guidance when [deleting keys](../../administration/credentials_inventory.md#delete-a-users-ssh-key).
- GitLab checks all SSH keys at 01:00 AM UTC every day. It emails an expiration notice for all SSH keys that are scheduled to expire seven days from now.
- GitLab checks all SSH keys at 02:00 AM UTC every day. It emails an expiration notice for all SSH keys that expire on the current date.
1. Select **Add key**.
--
GitLab
From 869e1c6e65ff1d8184e8add978efc15097445346 Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Mon, 21 Oct 2024 12:07:14 +0200
Subject: [PATCH 07/12] Add top-level heading
---
doc/topics/git/ssh_keys.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/doc/topics/git/ssh_keys.md b/doc/topics/git/ssh_keys.md
index 8f1da88c1e63b7..4ceb2fdb078071 100644
--- a/doc/topics/git/ssh_keys.md
+++ b/doc/topics/git/ssh_keys.md
@@ -4,6 +4,8 @@ group: Authentication
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
---
+# Generate an SSH key pair
+
DETAILS:
**Tier:** Free, Premium, Ultimate
**Offering:** GitLab.com, Self-managed, GitLab Dedicated
--
GitLab
From 02655670a43ef949713493f3adfa762831afe534 Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Mon, 21 Oct 2024 12:47:16 +0200
Subject: [PATCH 08/12] Fix spacing issues
---
doc/topics/git/ssh_keys.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/topics/git/ssh_keys.md b/doc/topics/git/ssh_keys.md
index 4ceb2fdb078071..32f223a65adce4 100644
--- a/doc/topics/git/ssh_keys.md
+++ b/doc/topics/git/ssh_keys.md
@@ -44,7 +44,7 @@ Before generating a new SSH key pair, check if a pair already exists:
`ls -al ~/.ssh`
```
-In the output, look for files named `id_ed25519.pub`,`id_rsa.pub`, or similar.
+In the output, look for files named `id_ed25519.pub`, `id_rsa.pub`, or similar.
If no file are found, proceed to generate a new key pair.
## Generate a new SSH key pair
@@ -52,7 +52,7 @@ If no file are found, proceed to generate a new key pair.
To generate a new SSH key pair:
1. Open a terminal.
-1. Run the `ssh-keygen -t` command and replace `<comment>` with your email address.
+1. Run the `ssh-keygen -t` command and replace `<comment>` with your email address.
- Example for ED25519:
--
GitLab
From 97c68065851896a79452e9b48c5ba0e9c2a9e279 Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Mon, 21 Oct 2024 12:47:50 +0200
Subject: [PATCH 09/12] Remove unnecessary tick
---
doc/topics/git/ssh_keys.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/topics/git/ssh_keys.md b/doc/topics/git/ssh_keys.md
index 32f223a65adce4..41a0e8168979c5 100644
--- a/doc/topics/git/ssh_keys.md
+++ b/doc/topics/git/ssh_keys.md
@@ -41,7 +41,7 @@ For more information on the supported SSH key types, see [SSH keys](../../user/s
Before generating a new SSH key pair, check if a pair already exists:
```shell
-`ls -al ~/.ssh`
+ls -al ~/.ssh
```
In the output, look for files named `id_ed25519.pub`, `id_rsa.pub`, or similar.
--
GitLab
From d4db457924341074ebe65f75d15eb6e210701688 Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Mon, 21 Oct 2024 13:24:03 +0200
Subject: [PATCH 10/12] Add troubleshooting and related topics sections
---
doc/topics/git/ssh_keys.md | 66 ++++++++++++++++++++++++++++++++++++--
1 file changed, 63 insertions(+), 3 deletions(-)
diff --git a/doc/topics/git/ssh_keys.md b/doc/topics/git/ssh_keys.md
index 41a0e8168979c5..8f1b96b5e0b955 100644
--- a/doc/topics/git/ssh_keys.md
+++ b/doc/topics/git/ssh_keys.md
@@ -75,11 +75,12 @@ A confirmation is displayed, including information about where your files are st
To use SSH with GitLab:
+1. Open a terminal.
1. Copy your public key to the clipboard. For example, to copy an ED25519 key:
::Tabs
- :::macOS
+ :::TabTitle macOS
```shell
tr -d '\n' < ~/.ssh/id_ed25519.pub | pbcopy
@@ -87,7 +88,7 @@ To use SSH with GitLab:
Replace `id_ed25519.pub` with your filename.
- :::Linux
+ :::TabTitle Linux
Requires the `xclip` package.
@@ -97,7 +98,7 @@ To use SSH with GitLab:
Replace `id_ed25519.pub` with your filename. Replace `id_ed25519.pub` with your filename.
- :::Windows
+ :::TabTitle Windows
Requires Git Bash.
@@ -124,3 +125,62 @@ To use SSH with GitLab:
- GitLab checks all SSH keys at 01:00 AM UTC every day. It emails an expiration notice for all SSH keys that are scheduled to expire seven days from now.
- GitLab checks all SSH keys at 02:00 AM UTC every day. It emails an expiration notice for all SSH keys that expire on the current date.
1. Select **Add key**.
+
+## Verify your SSH connection
+
+To verify that your SSH key was added correctly:
+
+1. Open a terminal;
+1. Test your SSH connection to GitLab:
+
+ ```shell
+ ssh -T git@gitlab.com
+ ```
+
+ Replace `git@gitlab.com` with your GitLab instance's hostname.
+
+1. If this it the first time connecting, the following message is returned:
+
+ ```plaintext
+ The authenticity of host 'gitlab.example.com (35.231.145.151)' can't be established.
+ ECDSA key fingerprint is SHA256:HbW3g8zUjNSksFbqTiUWPWg2Bq1x8xdGUrliXFzSnUw.
+ Are you sure you want to continue connecting (yes/no)? yes
+ Warning: Permanently added 'gitlab.example.com' (ECDSA) to the list of known hosts.
+ ```
+
+ Type `yes` and press <kbd>Enter</kbd>.
+
+1. Run the `ssh -T git@gitlab.example.com` command again. You should see the following welcome message:
+
+ ```plaintext
+ Welcome to GitLab, @username!
+ ```
+
+## Related topics
+
+- [Use SSH keys to communicate with GitLab](../../user/ssh.md)
+- [2FA for Git over SSH operations](../../security/two_factor_authentication.md#2fa-for-git-over-ssh-operations)
+- [Delete an SSH key](../../user/ssh.md#delete-an-ssh-key)
+- [Troubleshooting SSH](../../user/ssh_troubleshooting.md).
+
+## Troubleshooting
+
+If you cannot connect to GitLab, make sure:
+
+- You added your SSH key to your GitLab account.
+- You have the correct hostname for your GitLab instance.
+- You have the correct permissions to the GitLab instance.
+- Your SSH key is not password protected.
+
+### Verify SSH connection fails
+
+If verifying your SSH connection fails, troubleshoot your connection with `ssh` in verbose mode:
+
+1. Open your terminal.
+1. Run the `ssh` command in verbose mode:
+
+ ```shell
+ ssh -Tvvv git@gitlab.com
+ ```
+
+ Replace `git@gitlab.com` with your GitLab instance's hostname.
--
GitLab
From 54a46d9e4d31f84e80a4354f37a66188cf52be05 Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Wed, 23 Oct 2024 16:48:15 +0200
Subject: [PATCH 11/12] Delete newly added ssh_keys.md file
---
doc/topics/git/ssh_keys.md | 186 -------------------------------------
1 file changed, 186 deletions(-)
delete mode 100644 doc/topics/git/ssh_keys.md
diff --git a/doc/topics/git/ssh_keys.md b/doc/topics/git/ssh_keys.md
deleted file mode 100644
index 8f1b96b5e0b955..00000000000000
--- a/doc/topics/git/ssh_keys.md
+++ /dev/null
@@ -1,186 +0,0 @@
----
-stage: Govern
-group: Authentication
-info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
----
-
-# Generate an SSH key pair
-
-DETAILS:
-**Tier:** Free, Premium, Ultimate
-**Offering:** GitLab.com, Self-managed, GitLab Dedicated
-
-SSH keys provide secure communication between your computer and GitLab.
-When you use SSH keys to authenticate to the GitLab remote server,
-you don't need to supply your username and password each time.
-
-SSH uses two keys:
-
-- A public key that can be shared.
-- A private key that should be kept secure.
-
-## Prerequisites
-
-- Git must be installed on your computer. For information on how to install Git, see [Install Git](how_to_install_git/index.md).
-- The OpenSSH client, which comes pre-installed on GNU/Linux, macOS, and Windows 10.
-- SSH version 6.5 or later. Earlier versions used an MD5 signature, which is not secure.
-
-## Supported SSH key types
-
-GitLab supports the following SSH key types:
-
-- ED25519
-- ED25519_SK
-- ECDSA_SK
-- RSA
-
-For more information on the supported SSH key types, see [SSH keys](../../user/ssh.md#supported-ssh-key-types).
-
-## Check for existing SSH keys
-
-Before generating a new SSH key pair, check if a pair already exists:
-
-```shell
-ls -al ~/.ssh
-```
-
-In the output, look for files named `id_ed25519.pub`, `id_rsa.pub`, or similar.
-If no file are found, proceed to generate a new key pair.
-
-## Generate a new SSH key pair
-
-To generate a new SSH key pair:
-
-1. Open a terminal.
-1. Run the `ssh-keygen -t` command and replace `<comment>` with your email address.
-
- - Example for ED25519:
-
- ```shell
- ssh-keygen -t ed25519 -C "<comment>"
- ```
-
- - Example for 2048-bit RSA:
-
- ```shell
- ssh-keygen -t rsa -b 2048 -C "<comment>"
- ```
-
-1. Press <kbd>Enter</kbd> to accept the default filename and directory, or [configure SSH to point to a different directory](../../user/ssh.md#configure-ssh-to-point-to-a-different-directory).
-1. For added security, specify a [passphrase](https://www.ssh.com/academy/ssh/passphrase).
-
-A confirmation is displayed, including information about where your files are stored.
-
-## Add your SSH key to your GitLab account
-
-To use SSH with GitLab:
-
-1. Open a terminal.
-1. Copy your public key to the clipboard. For example, to copy an ED25519 key:
-
- ::Tabs
-
- :::TabTitle macOS
-
- ```shell
- tr -d '\n' < ~/.ssh/id_ed25519.pub | pbcopy
- ```
-
- Replace `id_ed25519.pub` with your filename.
-
- :::TabTitle Linux
-
- Requires the `xclip` package.
-
- ```shell
- xclip -sel clip < ~/.ssh/id_ed25519.pub
- ```
-
- Replace `id_ed25519.pub` with your filename. Replace `id_ed25519.pub` with your filename.
-
- :::TabTitle Windows
-
- Requires Git Bash.
-
- ```shell
- cat ~/.ssh/id_ed25519.pub | clip
- ```
-
- Replace `id_ed25519.pub` with your filename.
-
- ::EndTabs
-
-1. Go to GitLab and sign in.
-1. On the left sidebar, select your avatar.
-1. Select **Edit profile**.
-1. On the left sidebar, select **SSH Keys**.
-1. Select **Add new key**.
-1. In the **Key** box, paste the contents of your public key.
-1. In the **Title** box, type a description, like `Work Laptop` or
- `Home Workstation`.
-1. Optional. Select the **Usage type** of the key. It can be used either for `Authentication` or `Signing` or both. `Authentication & Signing` is the default value.
-1. Optional. Update **Expiration date** to modify the default expiration date.
- - Administrators can view expiration dates and use them for
- guidance when [deleting keys](../../administration/credentials_inventory.md#delete-a-users-ssh-key).
- - GitLab checks all SSH keys at 01:00 AM UTC every day. It emails an expiration notice for all SSH keys that are scheduled to expire seven days from now.
- - GitLab checks all SSH keys at 02:00 AM UTC every day. It emails an expiration notice for all SSH keys that expire on the current date.
-1. Select **Add key**.
-
-## Verify your SSH connection
-
-To verify that your SSH key was added correctly:
-
-1. Open a terminal;
-1. Test your SSH connection to GitLab:
-
- ```shell
- ssh -T git@gitlab.com
- ```
-
- Replace `git@gitlab.com` with your GitLab instance's hostname.
-
-1. If this it the first time connecting, the following message is returned:
-
- ```plaintext
- The authenticity of host 'gitlab.example.com (35.231.145.151)' can't be established.
- ECDSA key fingerprint is SHA256:HbW3g8zUjNSksFbqTiUWPWg2Bq1x8xdGUrliXFzSnUw.
- Are you sure you want to continue connecting (yes/no)? yes
- Warning: Permanently added 'gitlab.example.com' (ECDSA) to the list of known hosts.
- ```
-
- Type `yes` and press <kbd>Enter</kbd>.
-
-1. Run the `ssh -T git@gitlab.example.com` command again. You should see the following welcome message:
-
- ```plaintext
- Welcome to GitLab, @username!
- ```
-
-## Related topics
-
-- [Use SSH keys to communicate with GitLab](../../user/ssh.md)
-- [2FA for Git over SSH operations](../../security/two_factor_authentication.md#2fa-for-git-over-ssh-operations)
-- [Delete an SSH key](../../user/ssh.md#delete-an-ssh-key)
-- [Troubleshooting SSH](../../user/ssh_troubleshooting.md).
-
-## Troubleshooting
-
-If you cannot connect to GitLab, make sure:
-
-- You added your SSH key to your GitLab account.
-- You have the correct hostname for your GitLab instance.
-- You have the correct permissions to the GitLab instance.
-- Your SSH key is not password protected.
-
-### Verify SSH connection fails
-
-If verifying your SSH connection fails, troubleshoot your connection with `ssh` in verbose mode:
-
-1. Open your terminal.
-1. Run the `ssh` command in verbose mode:
-
- ```shell
- ssh -Tvvv git@gitlab.com
- ```
-
- Replace `git@gitlab.com` with your GitLab instance's hostname.
--
GitLab
From a4907517264f7ffbdb16575f7f3589e0e52e215a Mon Sep 17 00:00:00 2001
From: Brendan Lynch <blynch@gitlab.com>
Date: Wed, 23 Oct 2024 17:04:25 +0200
Subject: [PATCH 12/12] Update info for SSH keys and other minor edits
---
doc/topics/git/how_to_install_git/index.md | 21 ++++++++++++---------
1 file changed, 12 insertions(+), 9 deletions(-)
diff --git a/doc/topics/git/how_to_install_git/index.md b/doc/topics/git/how_to_install_git/index.md
index 078b487b9f2eed..bd8acf442cf4cc 100644
--- a/doc/topics/git/how_to_install_git/index.md
+++ b/doc/topics/git/how_to_install_git/index.md
@@ -7,13 +7,16 @@ description: "How to install Git on your local machine."
# Install Git
-To begin contributing to GitLab projects, you must download and install the Git client on your computer.
-
-This page provides information on installing Git on macOS and Ubuntu Linux.
+To contribute to GitLab projects, you must download and install the Git client on your local machine.
+This page explains how to install and configure Git on macOS and Ubuntu Linux.
For information on downloading and installing Git on other operating systems, see the
[official Git website](https://git-scm.com/downloads).
+After you install and configure Git, [generate and add an SSH key pair](../../../user/ssh.md#generate-an-ssh-key-pair)
+to your GitLab account. GitLab uses the SSH protocol to securely communicate with Git.
+With SSH, you can authenticate to the GitLab remote server without entering your username and password each time.
+
## Install and update Git
::Tabs
@@ -28,7 +31,7 @@ To install the latest version of Git on macOS with Homebrew:
1. If you've never installed Homebrew before, follow the
[Homebrew installation instructions](https://brew.sh/index.html).
1. In a terminal, install Git by running `brew install git`.
-1. Verify that Git works on your computer:
+1. Verify that Git works on your local machine:
```shell
git --version
@@ -55,7 +58,7 @@ To install the latest version of Git on Ubuntu Linux with a PPA:
sudo apt-get install git
```
-1. Verify that Git works on your computer:
+1. Verify that Git works on your local machine:
```shell
git --version
@@ -71,7 +74,7 @@ sudo apt-get update && sudo apt-get install git
## Configure Git
-To start using Git from your computer, you must enter your credentials
+To start using Git from your local machine, you must enter your credentials
to identify yourself as the author of your work.
You can configure your Git identity locally or globally:
@@ -131,15 +134,15 @@ The full name and email address should match the ones you use in GitLab.
::EndTabs
+### Check Git configuration settings
+
To check your configured Git settings, run:
```shell
git config user.name && git config user.email
```
-After you set your name and email address, you should add an SSH key.
-See [Use SSH keys to communicate with GitLab](../../../user/ssh.md).
-
## Related topics
- [Git configuration documentation](https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration)
+- [Use SSH keys to communicate with GitLab](../../../user/ssh.md)
--
GitLab