docs: add procedure to enable jenkins jobs 93/4193/2
authorRyota MIBU <r-mibu@cq.jp.nec.com>
Thu, 10 Dec 2015 14:01:31 +0000 (23:01 +0900)
committerRyota MIBU <r-mibu@cq.jp.nec.com>
Thu, 10 Dec 2015 14:05:04 +0000 (23:05 +0900)
Change-Id: I12769854edec391bebc7537d0bb999d61a4d3086
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
docs/how-to-use-docs/documentation-example.rst

index 628162b..f9b8da2 100644 (file)
@@ -138,8 +138,22 @@ built files.
     /output/
     /releng/
 
-Verify Jobs
-===========
+Jenkins Jobs
+============
+
+Enabling Jenkins Jobs
+---------------------
+
+Jenkins in OPNFV infra performs the jobs to verify and update your documents.
+To make your project repository watched by Jenkins to execute those jobs, you
+have to add your project name in 'project-pattern' of the following jobs by
+sending patch to update `jjb/opnfv/opnfv-docs.yml`_ on gerrit.
+
+.. _jjb/opnfv/opnfv-docs.yml:
+    https://gerrit.opnfv.org/gerrit/gitweb?p=releng.git;a=blob;f=jjb/opnfv/opnfv-docs.yml;
+
+Verify Job
+----------
 
 The verify job name is **opnfv-docs-verify**.
 
@@ -160,8 +174,8 @@ Currently, the job reports 'SUCCESS' as result of document build even if the
 PDF creation failed. This is a provisional workaround, since many projects are
 not ready for PDF creation yet.
 
-Merge Jobs
-==========
+Merge Job
+----------
 
 The merge job name is **opnfv-docs-merge**.