summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2015-12-10 23:01:31 +0900
committerRyota MIBU <r-mibu@cq.jp.nec.com>2015-12-10 23:05:04 +0900
commit1623f49e292957e46ba4e352217998624a060b90 (patch)
tree1b340fd83ab4d1946ce164c9e0a5d77a08940f66
parent7f61502374b4e2f54e1861ba3eaa1dc7f53b4416 (diff)
docs: add procedure to enable jenkins jobs
Change-Id: I12769854edec391bebc7537d0bb999d61a4d3086 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
-rw-r--r--docs/how-to-use-docs/documentation-example.rst22
1 files changed, 18 insertions, 4 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
index 628162b79..f9b8da2f1 100644
--- a/docs/how-to-use-docs/documentation-example.rst
+++ b/docs/how-to-use-docs/documentation-example.rst
@@ -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**.