From 409a846a3d76542a1eb7281f1a875090f46561fc Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Fri, 27 Apr 2018 12:44:55 -0400 Subject: [PATCH] Update rtd-jobs configuration docs for v2 API Update the project documentation section to reflect changes in global-jjb to use the v2 RTD API. Change-Id: I6171007fd13fbc08c2cf22ef11ee21fc201a4ebe Signed-off-by: Thanh Ha --- docs/project-documentation.rst | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/project-documentation.rst b/docs/project-documentation.rst index 9c2069c..92105b9 100644 --- a/docs/project-documentation.rst +++ b/docs/project-documentation.rst @@ -51,6 +51,12 @@ Bootstrap your project with documentation by following these steps. Open a :ref:`Helpdesk ` ticket if you require assistence here. +#. Create RTD Generic Webhook + + Follow the steps described in the `rtd-jobs documentation + `_ + then record the ``rtd-build-url`` and ``rtd-token`` for the next step. + #. Add the rtd jobs to your project Open up your project.yaml in the ci-management repo and add this section:: @@ -61,11 +67,17 @@ Bootstrap your project with documentation by following these steps. - '{project-name}-rtd-jobs' project-pattern: PROJECT - rtd-project: RTD_PROJECT + rtd-build-url: RTD_BUILD_URL + rtd-token: RTD_TOKEN :name: Project name in Gerrit converting forward slashes (/) to dashes (-). :project-pattern: Project name as defined in Gerrit. - :rtd-project: Project name as defined in ReadTheDocs. + :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) More details on rtd job template configuration and parameters is available :ref:`here `. -- 2.16.6