With these changes we can create new gates for checking the repository api-site as well as the API site repositories: doctest.py --force --check-build --api-site doctest.py --check-niceness --api-site doctest.py --check-syntax --api-site This checks also wadl files for syntax and niceness. Note that the other checks need further work. Also, --check-build really needs --force to build everything since the dependency generation does not handle the xml code of the repo yet. The building only works on api-site yet, needs more work for the other projects. The functions validate_all_files and validate_individual_files have been refactored to use one common function - thus removing some duplicated code. Change-Id: I214b4837401b2bcd46e5c6fa2e71b118254490d6
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:
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: