Fix WriteGood lint errors

Change-Id: I5e8331c42fa1dcfefac62f03d3e1f57eb8713c16
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/docs/index.rst b/docs/index.rst
index c1d16db..bce1ed9 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -19,8 +19,8 @@ Guides
 Global JJB Templates
 --------------------
 
-Job templates are designed in the `jjb/` directory but documentation is located
-in the `docs/jjb/` directory of this project.
+Job template code is in the `jjb/` directory but documentation is in the
+`docs/jjb/` directory of this project.
 
 - :doc:`jjb/lf-ci-jobs`
 - :doc:`jjb/lf-macros`

diff --git a/docs/jjb/lf-node-jobs.rst b/docs/jjb/lf-node-jobs.rst
index 028bae9..7028001 100644 (file)
--- a/docs/jjb/lf-node-jobs.rst
+++ b/docs/jjb/lf-node-jobs.rst
@@ -6,7 +6,7 @@ Job Groups
 ==========
 
 {project-name}-node-jobs
---------------------------
+------------------------
 
 Jobs for NodeJS projects using Gerrit.
 
@@ -15,7 +15,7 @@ Jobs for NodeJS projects using Gerrit.
     - gerrit-node-verify
 
 {project-name}-github-node-jobs
----------------------------------
+-------------------------------
 
 Jobs for NodeJS projects using GitHub.
 
@@ -27,7 +27,7 @@ Job Templates
 =============
 
 Node Verify
-----------
+-----------
 
 Verify job for NodeJS projects
 
@@ -40,10 +40,9 @@ Verify job for NodeJS projects
 :Required parameters:
 
     :build-node: The node to run build on.
-    :jenkins-ssh-credential: Credential to use for SSH. (Generally should
-        be configured in defaults.yaml)
-    :node-version: Version of NodeJS to install. A default is configured
-        via the job-group if a job-group is used.
+    :jenkins-ssh-credential: Credential to use for SSH. (Generally set
+        in defaults.yaml)
+    :node-version: Version of NodeJS to install. Default defined in job-group.
 
 :Optional parameters:
 
@@ -53,11 +52,11 @@ Verify job for NodeJS projects
     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
     :node-dir: Path to a NodeJS project to run node test against
         (default: '')
-    :stream: Keyword that can be used to represent a release code-name.
+    :stream: Keyword representing a release code-name.
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)
 
     :gerrit_verify_triggers: Override Gerrit Triggers.
-    :gerrit_trigger_file_paths: Override file paths which can be used to
-        filter which file modifications will trigger a build.
+    :gerrit_trigger_file_paths: Override file paths filter which checks which
+        file modifications will trigger a build.

diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst
index 02fff2b..624026d 100644 (file)
--- a/docs/jjb/lf-python-jobs.rst
+++ b/docs/jjb/lf-python-jobs.rst
@@ -40,8 +40,8 @@ Tox runner to verify a project
 :Required Parameters:
 
     :build-node: The node to run build on.
-    :jenkins-ssh-credential: Credential to use for SSH. (Generally should
-        be configured in defaults.yaml)
+    :jenkins-ssh-credential: Credential to use for SSH. (Generally set
+        in defaults.yaml)
 
 :Optional Parameters:
 
@@ -49,7 +49,7 @@ Tox runner to verify a project
     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
     :build-timeout: Timeout in seconds before aborting build. (default: 10)
     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
-    :stream: Keyword that can be used to represent a release code-name.
+    :stream: Keyword representing a release code-name.
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)

diff --git a/docs/jjb/lf-rtd-jobs.rst b/docs/jjb/lf-rtd-jobs.rst
index 66181a4..32a8117 100644 (file)
--- a/docs/jjb/lf-rtd-jobs.rst
+++ b/docs/jjb/lf-rtd-jobs.rst
@@ -6,9 +6,9 @@ Job Groups
 ==========
 
 {project-name}-rtd-jobs
-----------------------
+-----------------------
 
-Jobs that should be deployed for a project producing ReadTheDocs using Gerrit.
+Jobs to deploy for a project producing ReadTheDocs using Gerrit.
 
 :Includes:
 
@@ -16,9 +16,9 @@ Jobs that should be deployed for a project producing ReadTheDocs using Gerrit.
     - gerrit-rtd-verify
 
 {project-name}-github-rtd-jobs
------------------------------
+------------------------------
 
-Jobs that should be deployed for a project producing ReadTheDocs using GitHub.
+Jobs to deploy for a project producing ReadTheDocs using GitHub.
 
 :Includes:
 
@@ -52,8 +52,8 @@ Merge job which triggers a POST of the docs project to readthedocs
 :Required parameters:
 
     :build-node: The node to run build on.
-    :jenkins-ssh-credential: Credential to use for SSH. (Generally should
-        be configured in defaults.yaml)
+    :jenkins-ssh-credential: Credential to use for SSH. (Generally set
+        in defaults.yaml)
     :rtd-project: This is the name of the project on ReadTheDocs.org.
 
 :Optional parameters:
@@ -62,15 +62,15 @@ Merge job which triggers a POST of the docs project to readthedocs
     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
     :build-timeout: Timeout in seconds before aborting build. (default: 15)
     :git-url: base URL of git project. (default: https://github.com)
-    :project-pattern: Project to trigger build against. (default: **)
-    :stream: Keyword that can be used to represent a release code-name.
+    :project-pattern: Project to trigger build against. (default: \*\*)
+    :stream: Keyword representing a release code-name.
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)
 
     :gerrit_merge_triggers: Override Gerrit Triggers.
-    :gerrit_trigger_file_paths: Override file paths which can be used to
-        filter which file modifications will trigger a build.
+    :gerrit_trigger_file_paths: Override file paths filter which checks which
+        file modifications will trigger a build.
         **default**::
 
             - compare-type: ANT
@@ -92,8 +92,8 @@ Verify job which runs a tox build of the docs project
 :Required Parameters:
 
     :build-node: The node to run build on.
-    :jenkins-ssh-credential: Credential to use for SSH. (Generally should
-        be configured in defaults.yaml)
+    :jenkins-ssh-credential: Credential to use for SSH. (Generally set
+        in defaults.yaml)
 
 :Optional Parameters:
 
@@ -104,15 +104,15 @@ Verify job which runs a tox build of the docs project
     :doc-dir: Directory where tox will place built docs.
         as defined in the tox.ini (default: docs/_build/html)
     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
-    :project-pattern: Project to trigger build against. (default: **)
-    :stream: Keyword that can be used to represent a release code-name.
+    :project-pattern: Project to trigger build against. (default: \*\*)
+    :stream: Keyword representing a release code-name.
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)
 
     :gerrit_verify_triggers: Override Gerrit Triggers.
-    :gerrit_trigger_file_paths: Override file paths which can be used to
-        filter which file modifications will trigger a build.
+    :gerrit_trigger_file_paths: Override file paths filter which checks which
+        file modifications will trigger a build.
         **default**::
 
             - compare-type: ANT