1423480fb6
The following spec defines what each project's doc/source directory is supposed to look like: https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html I had not yet moved existing content to follow this design. This patch does that, moving the devref to the 'contributor' directory. It also moves the CLI related documentation into the 'cli' directory. I have updated the autodoc generation to now create the api documentation in 'doc/source/contributor/api'. This patch also creates a template for future documentation contribution. I have created all of the directories recommended by the spec and have included documentation as to what should go in each directory. The index file is updated to point at the new locations for existing content. 'doc/.gitignore' is updated so that it won't complain about the automatically generated 'doc/contributor/api' directory. Change-Id: I55c50fa0b7c1d06c91e40dbcfd11b1c8e8378aa6
45 lines
1.8 KiB
ReStructuredText
45 lines
1.8 KiB
ReStructuredText
Continuous Integration with Jenkins
|
|
===================================
|
|
|
|
Cinder uses a `Jenkins`_ server to automate development tasks. The Jenkins
|
|
front-end is at http://jenkins.openstack.org. You must have an
|
|
account on `Launchpad`_ to be able to access the OpenStack Jenkins site.
|
|
|
|
Jenkins performs tasks such as:
|
|
|
|
`gate-cinder-pep8`_
|
|
Run PEP8 checks on proposed code changes that have been reviewed.
|
|
|
|
`gate-cinder-pylint`_
|
|
Run Pylint checks on proposed code changes that have been reviewed.
|
|
|
|
`gate-cinder-python27`_
|
|
Run unit tests using python2.7 on proposed code changes that have been reviewed.
|
|
|
|
`gate-cinder-python34`_
|
|
Run unit tests using python3.4 on proposed code changes that have been reviewed.
|
|
|
|
`cinder-coverage`_
|
|
Calculate test coverage metrics.
|
|
|
|
`cinder-docs`_
|
|
Build this documentation and push it to `OpenStack Cinder <https://docs.openstack.org/cinder/latest/>`_.
|
|
|
|
`cinder-merge-release-tags`_
|
|
Merge reviewed code into the git repository.
|
|
|
|
`cinder-tarball`_
|
|
Do ``python setup.py sdist`` to create a tarball of the cinder code and upload
|
|
it to http://tarballs.openstack.org/cinder
|
|
|
|
.. _Jenkins: http://jenkins-ci.org
|
|
.. _Launchpad: http://launchpad.net
|
|
.. _gate-cinder-pep8: https://jenkins.openstack.org/job/gate-cinder-pep8
|
|
.. _gate-cinder-pylint: https://jenkins.openstack.org/job/gate-cinder-pylint
|
|
.. _gate-cinder-python27: https://jenkins.openstack.org/job/gate-cinder-python27
|
|
.. _gate-cinder-python34: https://jenkins.openstack.org/job/gate-cinder-python34
|
|
.. _cinder-coverage: https://jenkins.openstack.org/job/cinder-coverage
|
|
.. _cinder-docs: https://jenkins.openstack.org/job/cinder-docs
|
|
.. _cinder-merge-release-tags: https://jenkins.openstack.org/job/cinder-merge-release-tags
|
|
.. _cinder-tarball: https://jenkins.openstack.org/job/cinder-tarball
|