Tools used by OpenStack Documentation
Go to file
Andreas Jaeger 4c10a00147 Add tox.ini
Add initial tox.ini file for integration with OpenStack

Change-Id: I32115bed3cee3fb97fa7dc5622b8f42374e3d1d2
2013-12-18 19:49:15 +01:00
autogenerate-config-docs Merge "Remove flagmappings" 2013-12-17 20:02:54 +00:00
bin Rework repository to make it an installable python package 2013-12-14 22:53:18 +01:00
cleanup Fix cleanup tools 2013-10-08 14:24:07 +02:00
os_doc_tools Rework repository to make it an installable python package 2013-12-14 22:53:18 +01:00
sitemap Updates sitemap.xml for havana release links 2013-10-21 18:46:55 -05:00
.gitignore Rework repository to make it an installable python package 2013-12-14 22:53:18 +01:00
.gitreview Add .gitreview 2013-12-04 20:44:41 +01:00
LICENSE Add LICENSE and README.rst 2013-12-10 15:45:37 +01:00
MANIFEST.in Rework repository to make it an installable python package 2013-12-14 22:53:18 +01:00
README.rst Add LICENSE and README.rst 2013-12-10 15:45:37 +01:00
requirements.txt Rework repository to make it an installable python package 2013-12-14 22:53:18 +01:00
setup.cfg Rework repository to make it an installable python package 2013-12-14 22:53:18 +01:00
setup.py Rework repository to make it an installable python package 2013-12-14 22:53:18 +01:00
tox.ini Add tox.ini 2013-12-18 19:49:15 +01:00

README.rst

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

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:

http://wiki.openstack.org/HowToContribute

Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at:

http://wiki.openstack.org/GerritWorkflow

Pull requests submitted through GitHub will be ignored.

Bugs should be filed on Launchpad, not GitHub:

https://bugs.launchpad.net/openstack-manuals