05f9428303
This is an overhaul of the complete content to make it a separate python package that can be installed on the jenkins machines as well as on editor's machines. The goal of this patchset is to package everything and get the command "openstack-doc-test" running so that it can be used for gating. This will need further refinement for the other commands. Change-Id: Icc2f1807dd5ab5fb2f83c05d1b3895b3a9a0dbaf |
||
|---|---|---|
| autogenerate-config-docs | ||
| bin | ||
| cleanup | ||
| os_doc_tools | ||
| sitemap | ||
| .gitignore | ||
| .gitreview | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.rst | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
OpenStack Doc Tools
This repository contains tools used by the OpenStack Documentation project.
For more details, see the OpenStack Documentation wiki page.
Prerequisites
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 mavenOn Fedora:
yum install maven3Contributing
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
#openstack on irc.freenode.net.
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: