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
This commit is contained in:
Jeremy Stanley 2013-08-13 21:13:47 +00:00
parent 5b3b157650
commit 47c189f68a

View File

@ -118,14 +118,30 @@ should look something like::
jobs: jobs:
- python-jobs - python-jobs
- gate-{name}-pyflakes
- gate-{name}-pylint
List of jobs included to the ``python-jobs`` jobs group is located in List of jobs included to the ``python-jobs`` jobs group is located in
``modules/openstack_project/files/jenkins_job_builder/config/python-jobs.yaml``. ``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 - project:
``projects.yaml``. 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 Now that we have Jenkins jobs we need to tell Zuul to run them when
appropriate. Edit appropriate. Edit
@ -135,23 +151,19 @@ should look something like::
- name: stackforge/project-name - name: stackforge/project-name
check: 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-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-python26
- gate-project-name-python27 - gate-project-name-python27
post: post:
- project-name-coverage
- project-name-docs
- project-name-branch-tarball - project-name-branch-tarball
publish: - project-name-coverage
- project-name-docs - hook-project-name-rtfd
If you aren't ready to run any gate tests yet and did not configure 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:: python-jobs in project.yaml, it should look like this instead::