From 64ab18532b5aaaf0a5503672c173cc377fd0251c Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Tue, 6 Feb 2018 17:28:30 -0500 Subject: [PATCH] Include details on project-pattern param Change-Id: I0eb56eb84d0ea14fac87459d0372da892a900cba Signed-off-by: Thanh Ha --- docs/project-documentation.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/project-documentation.rst b/docs/project-documentation.rst index 86dd689..d5550e0 100644 --- a/docs/project-documentation.rst +++ b/docs/project-documentation.rst @@ -56,10 +56,16 @@ Bootstrap your project with documentation by following these steps. Open up your project.yaml in the ci-management repo and add this section:: - project: - name: blah + name: PROJECT jobs: - '{project-name}-rtd-jobs' - rtd-project: project + + project-pattern: PROJECT + rtd-project: RTD_PROJECT + + :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. More details on rtd job template configuration and parameters is available :ref:`here `. -- 2.16.6