Update RTD to use custom trigger url

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

diff --git a/docs/jjb/lf-rtd-jobs.rst b/docs/jjb/lf-rtd-jobs.rst
index 8f85f1a..2b3500e 100644 (file)
--- a/docs/jjb/lf-rtd-jobs.rst
+++ b/docs/jjb/lf-rtd-jobs.rst
@@ -44,7 +44,18 @@ Job Templates
 ReadTheDocs Merge
 -----------------
 
-Merge job which triggers a POST of the docs project to readthedocs
+Merge job which triggers a POST of the docs project to readthedocs.  There is some setup
+required on read the docs to get started with this.  After you have created the
+individual read the docs project (lets call it "PROJECT" here), then browse to
+https://readthedocs.org/dashboard/PROJECT/integrations/ and click on
+"Generic API incoming webhook".  Here you will see a custom url to trigger the job as
+well as a token.  Persist the token in the project Jenkins global-settings
+file.  You will need to put it in a username/password credentials type to make
+it available in the global-settings file.  set ```rtd-build-url to the
+custom build url as defined in read the docs.  Also set the rtd-server-id
+to the id you specified in the global-settings file, this will enable the script to parse
+the token out. Set ```rtd-project``` to your read the docs project name.
+
 
 :Template Names:
     - {project-name}-rtd-merge-{stream}
@@ -57,6 +68,11 @@ Merge job which triggers a POST of the docs project to readthedocs
     :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.
+    :rtd-build-url: This is the generic webhook url from readthedocs.org
+    :global-settings-file: This is the location of the Jenkins global settings file.
+        This file contains the entry with the location for the readthedocs build token.
+    :rtd-server-id: This is the id of the entry in the global-settings-file.
+
 
 :Optional parameters: