From 0b2db405e4bc8399daf2c4baf3299170213144a7 Mon Sep 17 00:00:00 2001 From: Khai Do Date: Fri, 23 Jan 2015 10:02:08 -0800 Subject: [PATCH] Update and clean up docs * Reference the readme.rst in index.rst to remove redundancy * General cleanup and updates Change-Id: I64e149087783e67d22fd0f2006accee2a1757ae0 --- README.rst | 14 ++++++++++---- doc/source/index.rst | 14 +++----------- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 9ae3aa5af..a3dcd5d57 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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 94955d917..f836c14a2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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