X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-rtd-jobs.rst;h=780fd626534e856f69f2839efce69d29efcee1a4;hb=0b1d0ba4945b93dc5d86fffef20f4be44fc5a2f9;hp=2b3500ea575be212ae7aa056f2ca9efe7554a91f;hpb=12d6179c0e7c208a360a3c61c0b715b49310b39e;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-rtd-jobs.rst b/docs/jjb/lf-rtd-jobs.rst index 2b3500ea..780fd626 100644 --- a/docs/jjb/lf-rtd-jobs.rst +++ b/docs/jjb/lf-rtd-jobs.rst @@ -44,18 +44,24 @@ Job Templates ReadTheDocs Merge ----------------- -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. +Merge job which triggers a POST of the docs project to readthedocs. +To use this job first configure the ``Generic API incoming webhook`` in +ReadTheDocs. To do that follow these steps: + +#. Browse to https://readthedocs.org/dashboard/PROJECT/integrations/ +#. Click on ``Generic API incoming webhook`` + + .. note:: + + If not available click on ``Add integration`` and add the + ``Generic API incoming webhook``. + +#. Copy the custom webhook URL, this is your ``rtd-build-url`` + + For example: https://readthedocs.org/api/v2/webhook/opendaylight/32321/ + +#. Copy the token, this is your ``rtd-token`` :Template Names: - {project-name}-rtd-merge-{stream} @@ -67,12 +73,12 @@ the token out. Set ```rtd-project``` to your read the docs project name. :build-node: The node to run build on. :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. - + :rtd-build-url: This is the generic webhook url from readthedocs.org. Refer + to the above instructions to generate one. + (Check Admin > Integrations > Generic API incoming webhook) + :rtd-token: The unique token for the project Generic webhook. Refer + to the above instructions to generate one. + (Check Admin > Integrations > Generic API incoming webhook) :Optional parameters: