7837131f36
- Clouddocs-maven-plugin reads service names and links to related API ref pages from the api-ref/src/docbkx/preface.xml file - Added an xml:id to the itemizedlist in the preface.xml file to identify it as the service names/links source - Added preface to every API reference page so that each page can auto-generate the sidebar menu from the itemizedlist in the preface Partial-Bug: #1267174 Change-Id: I8871c804c2c93f4f7625fc92ed0448de40ccb751 author: diane fleming
API-Site Repository
This repository contains documentation for the OpenStack project.
For more details, see the OpenStack Documentation wiki page.
It includes these manuals:
- API Quick Start
- API Complete Reference
In addition to these, this repository contains:
- api.openstack.org:
www
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 15 and later:
yum install maven3Building
The manuals are in the api-quick-start and
api-ref directories.
To build a specific guide, look for a pom.xml file
within a subdirectory, then run the mvn command in that
directory. For example:
cd api-quick-start
mvn clean generate-sourcesThe generated PDF documentation file is:
api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/api-quick-start-onepager.pdfThe root of the generated HTML documentation is:
api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/content/index.htmlTesting of changes and building of the manual
Install the python tox package and run tox from the
top-level directory to use the same tests that are done as part of our
Jenkins gating jobs.
If you like to run individual tests, run:
tox -e checkniceness- to run the niceness teststox -e checksyntax- to run syntax checkstox -e checkdeletions- to check that no deleted files are referencedtox -e checkbuild- to actually build the manual
tox will use the openstack-doc-tools package for execution of these tests. openstack-doc-tools has a requirement on maven for the build check.
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 documents, please see the Documentation HowTo.
Bugs
Bugs should be filed on Launchpad, not GitHub:
Installing
Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.