From 47c189f68a88cd5b9bd6d6dbbaccf2526c283f3f Mon Sep 17 00:00:00 2001
From: Jeremy Stanley <fungi@yuggoth.org>
Date: Tue, 13 Aug 2013 21:13:47 +0000
Subject: [PATCH] Document RTFD hook job template in StackForge doc
* doc/source/stackforge.rst: Add basic documentation for the RTFD
job template. Also remove references to pylint and pyflakes jobs
which are mostly phased out due to increased flake8 popularity.
Change-Id: I0a1461a6c766a85cfac49ffed1b44358aabb2bc1
---
doc/source/stackforge.rst | 44 +++++++++++++++++++++++++--------------
1 file changed, 28 insertions(+), 16 deletions(-)
diff --git a/doc/source/stackforge.rst b/doc/source/stackforge.rst
index 77eee0ddab..9c0696ec82 100644
--- a/doc/source/stackforge.rst
+++ b/doc/source/stackforge.rst
@@ -118,14 +118,30 @@ should look something like::
jobs:
- python-jobs
- - gate-{name}-pyflakes
- - gate-{name}-pylint
List of jobs included to the ``python-jobs`` jobs group is located in
``modules/openstack_project/files/jenkins_job_builder/config/python-jobs.yaml``.
+For document publication there's also a publisher job template for the
+popular `Read the Docs`_ documentation hosting service, which can be
+used by specifying the ``rtfd-id`` for the project (obtained from your
+readthedocs.org account) and then adding the ``hook-{name}-rtfd``
+template to the jobs list::
-If you aren't ready to run any gate tests yet, you don't need to edit
-``projects.yaml``.
+ - project:
+ name: project-name
+ github-org: stackforge
+ node: precise
+ rtfd-id: 7095
+ tarball-site: tarballs.openstack.org
+
+ jobs:
+ - python-jobs
+ - hook-{name}-rtfd
+
+.. _Read the Docs: https://readthedocs.org/
+
+If you aren't ready to run any gate tests or other project-specific
+jobs yet, you don't need to edit ``projects.yaml``.
Now that we have Jenkins jobs we need to tell Zuul to run them when
appropriate. Edit
@@ -135,23 +151,19 @@ should look something like::
- name: stackforge/project-name
check:
- - gate-project-name-pyflakes
- - gate-project-name-pep8
- - gate-project-name-docs
- - gate-project-name-python26
- - gate-project-name-python27
- gate:
- - gate-project-name-pep8
- - gate-project-name-pyflakes
- gate-project-name-docs
+ - gate-project-name-pep8
+ - gate-project-name-python26
+ - gate-project-name-python27
+ gate:
+ - gate-project-name-docs
+ - gate-project-name-pep8
- gate-project-name-python26
- gate-project-name-python27
post:
- - project-name-coverage
- - project-name-docs
- project-name-branch-tarball
- publish:
- - project-name-docs
+ - project-name-coverage
+ - hook-project-name-rtfd
If you aren't ready to run any gate tests yet and did not configure
python-jobs in project.yaml, it should look like this instead::