autogenerate-config-docs | ||
bin | ||
cleanup | ||
doc/source | ||
os_doc_tools | ||
sitemap | ||
tools | ||
.gitignore | ||
.gitreview | ||
HACKING.rst | ||
LICENSE | ||
MANIFEST.in | ||
openstack-common.conf | ||
README.rst | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
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 maven
On Fedora:
yum install maven3
This package needs a few external dependencies including lxml. If you do not have lxml installed, you can either install python-lxml or have it installed automatically and build from sources. To build lxml from sources, you need a C compiler and the xml and xslt development packages installed.
To install python-lxml, execute the following based on your distribution.
On Fedora:
yum install python-lxml
On openSUSE:
zypper in python-lxml
On Ubuntu:
apt-get install python-lxml
For building from source, install the dependencies of lxml.
On openSUSE:
zypper in libxslt-devel
On Ubuntu:
apt-get install libxml2-dev libxslt-dev
Contributing
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: