Add information about hacking and testing the repository. Change-Id: I48bc4e6342295a35959cbd796ac0be1fb08a9dd2
|9 years ago|
|autogenerate-config-docs||9 years ago|
|bin||9 years ago|
|cleanup||9 years ago|
|os_doc_tools||9 years ago|
|sitemap||9 years ago|
|tools||9 years ago|
|.gitignore||9 years ago|
|.gitreview||9 years ago|
|HACKING.rst||9 years ago|
|LICENSE||9 years ago|
|MANIFEST.in||9 years ago|
|README.rst||9 years ago|
|openstack-common.conf||9 years ago|
|requirements.txt||9 years ago|
|setup.cfg||9 years ago|
|setup.py||9 years ago|
|test-requirements.txt||9 years ago|
|tox.ini||9 years ago|
OpenStack Doc Tools
This repository contains tools used by the OpenStack Documentation project.
For more details, see the OpenStack Documentation wiki page.
Apache Maven must be installed to build the documentation.
To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:
apt-get install maven
yum install maven3
Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation. The best way to get involved with the community is to talk with others online or at a meetup and offer contributions through our processes, the OpenStack wiki, blogs, or on IRC at
We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.
If you would like to contribute to the development, you must follow the steps in the "If you're a developer, start here" section of this page:
Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at:
Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub: