summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorKhai Do <zaro0508@gmail.com>2015-01-23 10:02:08 -0800
committerKhai Do <zaro0508@gmail.com>2015-01-23 10:02:43 -0800
commit0b2db405e4bc8399daf2c4baf3299170213144a7 (patch)
tree27d97226575e66502928b5c5bea9888654164e34 /README.rst
parent4bf020e07e0dd938732a32eaeb40a67d939cbd94 (diff)
downloadpython-jenkins-job-builder-0b2db405e4bc8399daf2c4baf3299170213144a7.tar.gz
python-jenkins-job-builder-0b2db405e4bc8399daf2c4baf3299170213144a7.tar.xz
python-jenkins-job-builder-0b2db405e4bc8399daf2c4baf3299170213144a7.zip
Update and clean up docs
* Reference the readme.rst in index.rst to remove redundancy * General cleanup and updates Change-Id: I64e149087783e67d22fd0f2006accee2a1757ae0
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index 9ae3aa5a..a3dcd5d5 100644
--- a/README.rst
+++ b/README.rst
@@ -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