From: Ken Dreyer <kdreyer@redhat.com>
Date: Mon, 1 Dec 2014 18:15:07 +0000 (-0700)
Subject: doc: add notes about "documentation" jobs
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=8eab9b1f8dfacf5d869a0bc6bfcb0a4b5ae558ed;p=ceph-build.git

doc: add notes about "documentation" jobs

Add a bit of documentation regarding "documentation" jobs in Jenkins.
This records our lessons learned during Andrew's work to create the
"teuthology-docs-build" job configuration and get that particular one
running.
---

diff --git a/README.rst b/README.rst
index 32715f723..19ed20769 100644
--- a/README.rst
+++ b/README.rst
@@ -210,3 +210,12 @@ You should also use the ``triggers`` setting for the job, like so::
             github-hooks: true
             permit-all: false
             auto-close-on-fail: false
+
+"Document" Jobs
+---------------
+Some jobs don't actually run code; they simply build a project's documentation
+and upload the docs to ceph.com. One example is the "teuthology-docs-build"
+job.
+
+For these jobs, note that the destination directory must be created on the
+ceph.com web server before the ``rsync`` command will succeed.