jjb
/
jenkins-job-builder
Code Issues Proposed changes

Update and clean up docs 

* Reference the readme.rst in index.rst to remove redundancy
* General cleanup and updates

Change-Id: I64e149087783e67d22fd0f2006accee2a1757ae0
This commit is contained in:
Khai Do 2015-01-23 10:02:08 -08:00
parent 4bf020e07e
commit 0b2db405e4
2 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.rst
View File

@ -1,8 +1,8 @@
===================
Jenkins Job Builder
===================
======
README
======
Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format,
Jenkins Job Builder takes simple descriptions of Jenkins_ jobs in YAML_ format,
and uses them to configure Jenkins. You can keep your job descriptions in human
readable text format in a version control system to make changes and auditing
easier. It also has a flexible template system, so creating many similarly
@ -22,6 +22,10 @@ Bug report:
* https://storyboard.openstack.org/#!/project/723
Repository:
* https://git.openstack.org/cgit/openstack-infra/jenkins-job-builder
Cloning:
* git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
@ -72,6 +76,8 @@ Then install the required python packages using pip_::
$ sudo pip install PyYAML python-jenkins
.. _Jenkins: http://jenkins-ci.org/
.. _YAML: http://www.yaml.org/
.. _pep8: https://pypi.python.org/pypi/pep8
.. _pyflakes: https://pypi.python.org/pypi/pyflakes
.. _tox: https://testrun.org/tox

14
doc/source/index.rst
View File

@ -1,18 +1,10 @@
Jenkins Job Builder
===================
Jenkins Job Builder takes simple descriptions of Jenkins_ jobs in
YAML_ format, and uses them to configure Jenkins. You can keep your
job descriptions in human readable text format in a version control
system to make changes and auditing easier. It also has a flexible
template system, so creating many similarly configured jobs is easy.
.. _Jenkins: http://jenkins-ci.org/
.. _YAML: http://www.yaml.org/
Contents:
.. include:: ../../README.rst
Contents
========
.. toctree::
:maxdepth: 3