openstack
/
openstack-doc-tools
Code Issues Proposed changes
Tools used by OpenStack Documentation
151 Commits 1 Branch 62 Tags 6.9 MiB
Python 77.5%
Shell 20.3%
XSLT 2.2%
Go to file
Andreas Jaeger 855f7e6c60 Build markdown documents 
Build markdown documents as used in image-api and identity-api.

Change-Id: I6fcfd3472a53ba45db23946e67f89c576263f6bc
 		2013-12-28 19:52:50 +01:00
autogenerate-config-docs Fix issues found by flake8 2013-12-18 21:23:12 +01:00
bin Rework repository to make it an installable python package 2013-12-14 22:53:18 +01:00
cleanup Fix issues found by flake8 2013-12-18 21:23:12 +01:00
os_doc_tools Build markdown documents 2013-12-28 19:52:50 +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
HACKING.rst Add HACKING.rst 2013-12-18 22:00: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