diff options
author | Shankho Boron Ghosh <shankhoghosh123@gmail.com> | 2020-10-23 00:10:00 +0530 |
---|---|---|
committer | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2020-10-23 10:17:47 +0000 |
commit | de81a8b07f8139fa0f65dddffc839b4a5e83dad7 (patch) | |
tree | ac79454280799638fc7c0f9d6bc9e934b11e8580 /docs/5_How_To_Contribute/1_Getting_Linux_Foundation_account.md | |
parent | 13dda7db03587f9aa6d8095207e0d126b32141c7 (diff) |
Added Contribution Guide
Exhaustive Contribution Guide. Removed Trailing Whitespaces.
Updated index.md. Abandoned accidental commits 25474,
25474 and uploading a new patchset. Corrected code renderings.
v2 (jsmoeller): Update contribution subchapters
Bug-AGL: SPEC-3633
Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Ia808adc0208052f0591396860ac776e34070d279
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25473
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'docs/5_How_To_Contribute/1_Getting_Linux_Foundation_account.md')
-rw-r--r-- | docs/5_How_To_Contribute/1_Getting_Linux_Foundation_account.md | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/docs/5_How_To_Contribute/1_Getting_Linux_Foundation_account.md b/docs/5_How_To_Contribute/1_Getting_Linux_Foundation_account.md new file mode 100644 index 0000000..83a974d --- /dev/null +++ b/docs/5_How_To_Contribute/1_Getting_Linux_Foundation_account.md @@ -0,0 +1,100 @@ +--- +title: Getting Linux Foundation account +--- + +In order to participate in the development of the Automotive Grade Linux +project, you will need a Linux Foundation account. You will need to use +your LF ID to access to all the AGL community development tools, +including [Gerrit](http://gerrit.automotivelinux.org/), +[Jira](https://jira.automotivelinux.org/) and the +[Wiki](https://wiki.automotivelinux.org/) (for editing, only). + +**NOTE:** Further information about Contributing to the AGL Distro +available at [AGL wiki](https://wiki.automotivelinux.org/agl-distro/contributing). + +## Creating Linux Foundation ID + + 1. Go to the [Linux Foundation ID website](https://identity.linuxfoundation.org/). + + 2. Select the option `I need to create a Linux Foundation ID`, and fill + out the form that appears. (It is advised to authenticate through email + instead of logging through Facebook/Google/Github.) + + 3. Wait a few minutes, then look for an email message with the subject + line: `Validate your Linux Foundation ID email`. + + 4. Open the received URL to validate your email address. + + 5. Verify that your browser displays the message ``You have + successfully validated your e-mail address``. + + 6. Access [Gerrit](http://gerrit.automotivelinux.org/) by selecting + ``Sign In``, and use your new Linux Foundation account ID to sign in. + +## Configuring Gerrit to Use SSH + +Gerrit uses SSH to interact with your Git client. If you already have an SSH +key pair, you can skip the part of this section that explains how to generate one. + +What follows explains how to generate an SSH key pair in a Linux environment --- +follow the equivalent steps on your OS. + +First, create an SSH key pair with the command: + + ```sh + $ ssh-keygen -t rsa -C "John Doe john.doe@example.com" + ``` + +**Note:** This will ask you for a password to protect the private key as +it generates a unique key. Please keep this password private, and DO NOT +enter a blank password. + +The generated SSH key pair can be found in the files ``~/.ssh/id_rsa`` and +``~/.ssh/id_rsa.pub``. + +Next, add the private key in the ``id_rsa`` file to your key ring, e.g.: + + ```sh + $ ssh-add ~/.ssh/id_rsa + ``` + +Finally, add the public key of the generated key pair to the Gerrit +server, with the following steps: + +1. Go to [Gerrit](http://gerrit.automotivelinux.org/). + +2. Click on your account name in the upper right corner. + +3. From the pop-up menu, select ``Settings``. + +4. On the left side menu, click on ``SSH Public Keys``. + +5. Paste the contents of your public key ``~/.ssh/id_rsa.pub`` and click + ``Add key``. + +**Note:** The ``id_rsa.pub`` file can be opened with any text editor. +Ensure that all the contents of the file are selected, copied and pasted +into the ``Add SSH key`` window in Gerrit. + +**Note:** The SSH key generation instructions operate on the assumption +that you are using the default naming. It is possible to generate +multiple SSH keys and to name the resulting files differently. See the +[ssh-keygen](https://en.wikipedia.org/wiki/Ssh-keygen) documentation for +details on how to do that. Once you have generated non-default keys, you +need to configure SSH to use the correct key for Gerrit. In that case, +you need to create a ``~/.ssh/config`` file modeled after the one below. + + ```sh +host gerrit.automotivelinux.org + HostName gerrit.automotivelinux.org + IdentityFile ~/.ssh/id_rsa_automotivelinux_gerrit + User <LFID> +``` + +`<LFID>` is your Linux Foundation ID and the value of IdentityFile is the +name of the public key file you generated. + +**Warning:** Potential Security Risk! Do not copy your private key +``~/.ssh/id_rsa``. Use only the public ``~/.ssh/id_rsa.pub``. + + |