Include details on project-pattern param 03/8703/1
authorThanh Ha <thanh.ha@linuxfoundation.org>
Tue, 6 Feb 2018 22:28:30 +0000 (17:28 -0500)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Tue, 6 Feb 2018 22:28:54 +0000 (17:28 -0500)
Change-Id: I0eb56eb84d0ea14fac87459d0372da892a900cba
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
docs/project-documentation.rst

index 86dd689..d5550e0 100644 (file)
@@ -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 <lf-global-jjb-rtd-jobs>`.