670d9e063c
Using local copies instead of remote ones speeds up the process significantly since we do not need to download everytime more than 600 kb of data. The additional benefit is that testing now works also while you're offline, no need to do any internet connection for it. The files change seldom, so it is fine to add them. Tested with: time openstack-doc-test --api-site --check-syntax Before this change: real 0m4.020s user 0m0.212s sys 0m0.047s After this change: real 0m0.164s user 0m0.142s sys 0m0.022s Change-Id: I541e75580ae734ccd5d48d699eb48225203646e8
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 maven3This 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-lxmlOn openSUSE:
zypper in python-lxmlOn Ubuntu:
apt-get install python-lxmlFor building from source, install the dependencies of lxml.
On openSUSE:
zypper in libxslt-develOn Ubuntu:
apt-get install libxml2-dev libxslt-devUpdating RNG schema files
The repository contains in the directory
os_doc_tools/resources a local copy of some RNG schema
files so that they do not need to be downloaded each time for validation
of XML and WADL files.
Please see the README.txt in the directory for details
on where these files come from.
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: