From: Jessica Wagantall <jwagantall@linuxfoundation.org>
Date: Mon, 12 Mar 2018 20:42:55 +0000 (-0700)
Subject: Correct document titles
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=25e7c4f1e768eb5cfd08e1c46b23f0a09ebc4d59;p=releng%2Fdocs.git

Correct document titles

Correct documentation titles to make them
imperative mode.

Change-Id: Idfa872fb76462474daa02776029c72baf5097519
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
---

diff --git a/docs/best-practices.rst b/docs/best-practices.rst
index b94bb7d..1536440 100644
--- a/docs/best-practices.rst
+++ b/docs/best-practices.rst
@@ -102,7 +102,7 @@ follows.
     # Run the coala command
     coala --help
 
-Setting up Coala a Project
+Set up Coala for a Project
 --------------------------
 
 In some cases we may want to setup coala for a new project that wants to start
diff --git a/docs/gerrit.rst b/docs/gerrit.rst
index 266f449..4920e96 100644
--- a/docs/gerrit.rst
+++ b/docs/gerrit.rst
@@ -15,8 +15,8 @@ occur around the code commits.
 
    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.
 
@@ -38,7 +38,7 @@ In such case, use HTTPS.
 
    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::
 
@@ -192,8 +192,8 @@ Push patches to Gerrit
 
 .. _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.
@@ -223,8 +223,8 @@ Once pushed we should see some output in the terminal as described in
 
 .. _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>`.
@@ -460,8 +460,8 @@ This is important when merging dependent patches across projects. You will need
 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
 -----------------------------------
@@ -507,8 +507,8 @@ For a system running Ubuntu operating system, follow the steps below:
 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
@@ -550,8 +550,8 @@ SSHD port::
     ****    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
diff --git a/docs/gpg.rst b/docs/gpg.rst
index 92a936b..5e2369f 100644
--- a/docs/gpg.rst
+++ b/docs/gpg.rst
@@ -35,8 +35,8 @@ Prerequisites
 #. 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.
 
@@ -125,8 +125,8 @@ How to generate GPG keys
       'Add'.
 
 
-How to setup gpg-agent
-----------------------
+Setup gpg-agent
+---------------
 
 #. Install gpg-agent and pinentry-mac using brew:
 
@@ -184,8 +184,9 @@ How to setup gpg-agent
    .. 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.
diff --git a/docs/jenkins.rst b/docs/jenkins.rst
index 7903b44..5c4c83d 100644
--- a/docs/jenkins.rst
+++ b/docs/jenkins.rst
@@ -155,8 +155,8 @@ Facts to keep in mind before working on the Sandbox:
 - 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.
@@ -199,8 +199,8 @@ once or twice.
 
 .. _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
@@ -225,8 +225,8 @@ The job pushed into the Sandbox will reflect the changes made in the patch.
 
 .. _jjb-push-cli:
 
-Using JJB CLI
--------------
+Push jobs via JJB CLI
+---------------------
 
 JJB CLI needs configuration first.