Here is more information on `Gerrit <https://code.google.com/p/gerrit/>`_
-How to clone code
-=================
+Clone the code
+==============
Cloning the code into a local workspace can happen via HTTP or SSH.
For more information on how to generate the public/private key pair see
`Generating SSH keys for your system`_ and
- `Registering your SSH key with Gerrit`_
+ `Register your SSH key with Gerrit`_
.. note::
.. _gerrit-push-git-review:
-Pushing using git review
-------------------------
+Push using git review
+---------------------
We recommend using `git-review <https://docs.openstack.org/infra/git-review/>`_
if possible as it makes working with Gerrit much easier.
.. _gerrit-push-git-push:
-Pushing using git push
-----------------------
+Push using git push
+-------------------
This method is a useful fallback in situations where we cannot use
:ref:`git-review <gerrit-push-git-review>`.
for the merge job to run on one patch before any patches in other projects depending on
it will successful verify.
-Setting up Gerrit
-=================
+Set up Gerrit
+=============
Generating SSH keys for your system
-----------------------------------
Your public key is now available as **.ssh/id\_rsa.pub** in your home
folder.
-Registering your SSH key with Gerrit
-------------------------------------
+Register your SSH key with Gerrit
+---------------------------------
#. Using a Google Chrome or Mozilla Firefox browser, go to
gerrit.<project>.org
**** Welcome to Gerrit Code Review ****
-Submitting over HTTPS
-=====================
+Submit a patch over HTTPS
+=========================
While we recommend you submit patchsets over SSH some users may need to
submit patchsets over HTTPS due to corporate network policies such as
#. If you are using a GPG smartcard refer to `Protecting code integrity with PGP <https://github.com/lfit/itpol/blob/master/protecting-code-integrity.md/>`_
-How to generate GPG keys
-------------------------
+Generate the GPG keys
+---------------------
#. Generate your GPG key.
'Add'.
-How to setup gpg-agent
-----------------------
+Setup gpg-agent
+---------------
#. Install gpg-agent and pinentry-mac using brew:
.. figure:: _static/passphrase-mac.png
-How to sign your commit
------------------------
+Sign your commit
+----------------
+
#. Commit and push a change
a. Change a file and save it with your favorite editor.
- Sandbox jobs cannot vote on Gerrit
- Jenkins nodes have OpenStack configuration similarly to the production instance
-How to get access to the Sandbox
---------------------------------
+Get access to the Sandbox
+-------------------------
The Sandbox provides a testing/experimentation environment used before
pushing job templates to the production instance.
.. _jjb-push-gerrit-comment:
-Using Gerrit comment
---------------------
+Push jobs via Gerrit comment
+----------------------------
This is the easiest and fastest way to start using the Sandbox. This is the recommended
default way to use the Sandbox since this does not require the user to install JJB or
.. _jjb-push-cli:
-Using JJB CLI
--------------
+Push jobs via JJB CLI
+---------------------
JJB CLI needs configuration first.