Document comment triggers

[releng/global-jjb.git] / docs / jjb / lf-node-jobs.rst

diff --git a/docs/jjb/lf-node-jobs.rst b/docs/jjb/lf-node-jobs.rst
index 028bae9..d3feb1a 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
 
@@ -37,27 +37,28 @@ Verify job for NodeJS projects
     - gerrit-node-verify
     - github-node-verify
 
+:Comment Trigger: recheck|reverify
+
 :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:
 
     :branch: The branch to build against. (default: master)
     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
-    :build-timeout: Timeout in seconds before aborting build. (default: 10)
+    :build-timeout: Timeout in minutes before aborting build. (default: 10)
     :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.