Reword Push jobs to sandbox section 48/9248/2
authorThanh Ha <thanh.ha@linuxfoundation.org>
Tue, 6 Mar 2018 16:47:22 +0000 (11:47 -0500)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Tue, 6 Mar 2018 16:49:27 +0000 (11:49 -0500)
Improve this section with links and more clear explanation
of why and when to use each method.

Change-Id: Ibf81545e6d30889a34bbf99f152565bb81610ffe
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
docs/jenkins.rst

index abd8401..1caf94a 100644 (file)
@@ -48,12 +48,23 @@ The requester will receive an invitation to join this group.
 Once accepted, the user can now access the Sandbox same way as the production
 Jenkins.
 
-Pushing jobs to the Sandbox
----------------------------
+Push jobs to Jenkins Sandbox
+----------------------------
+
+Push jobs to the Jenkins Sandbox using one of these methods:
+
+1. :ref:`Via Gerrit Comment <jjb-push-gerrit-comment>`
+2. :ref:`Via JJB CLI <jjb-push-cli>`
 
-There are 2 supported ways to push jobs to the Sandbox the first one is easier and
-does not require you to install anything to your local system and uses a jjb-deploy
-job in production to push jobs from a Gerrit patch to the Sandbox.
+**Method 1** is easier as it does not require installing anything on your local
+system. This method requires pushing the patch to Gerrit on each test. We
+recommend this method for quick one off edits or if you are testing another
+contributor's patch.
+
+**Method 2** is more convenient for those who work on JJB templates more than
+once or twice.
+
+.. _jjb-push-gerrit-comment:
 
 Using Gerrit comment
 --------------------
@@ -79,6 +90,8 @@ The job pushed into the Sandbox will reflect the changes made in the patch.
    You can use * wildcard for job names. This is not a good practice.
    We highly recommended to use specific Jenkins job names instead.
 
+.. _jjb-push-cli:
+
 Using JJB CLI
 -------------