Edit how-to "Creating The SSH Keys And Apply In GitLab" #13

Closed philipwindecker closed 2 years ago

In GitLab by @jana.aydinbas on Oct 12, 2021, 10:23

Link: https://code.asam.net/common/asam-project-guide/-/blob/master/Wiki/docs/general_guidelines/Setup-Guide.asciidoc#user-content-creating-the-ssh-keys-and-apply-in-gitlab

Here are a few suggestions to make the how-to more comprehensible:

1. In a PowerShell window, enter the following:
[...]
ssh-keygen -t ed25519 -C "YourEmail@address.com"
Replace YourEmail@address.com with your company mail.

An example would be helpful to make clear that the quotation marks ("") are not part of the placeholder. Does it have to be the same e-mail address as in git config --global user.email "MY_NAME@example.com"?

4. Open the settings "SSH Keys" on the left

Looks like the wrong screenshot.

To cut back on the number of steps, this link could be provided earlier: https://code.asam.net/profile/keys

In GitLab by @philip.windecker on Oct 12, 2021, 11:02

assigned to @philip.windecker

In GitLab by @philip.windecker on Oct 12, 2021, 15:22

The email is just a comment added to the key here. As far as I know, it is not used in the actual authentication. But it is recommended by GitLab to use the creators email, so the guide picks this up again. I will add a NOTE to the file explaining this. Thank you very much for the info!

In GitLab by @philip.windecker on Oct 12, 2021, 15:22

Regarding the image: Thank you, that is indeed the wrong one! I will replace it. :)

In GitLab by @philip.windecker on Oct 12, 2021, 15:37

Ready for merge

In GitLab by @philip.windecker on Oct 19, 2021, 13:20

unassigned @philip.windecker

In GitLab by @philip.windecker on Oct 19, 2021, 13:20

marked this issue as related to #21

asam-ev / asam-project-guide

Edit how-to "Creating The SSH Keys And Apply In GitLab" #13