openstack
/
api-site
Code Issues Proposed changes
OpenStack API site
908 Commits 1 Branch 0 Tags 45 MiB
CSS 74.6%
JavaScript 15.7%
HTML 6.6%
Python 2.6%
Shell 0.5%
Go to file
Diane Fleming 927b792371 Add stub files for new API Guide 
Closes-Bug: #1269854

Change-Id: I01cc24ea65a69b5e1df532570a14de6f123e149f
author: Diane Fleming <diane.fleming@rackspace.com>
co-author: Miranda Zhang <miranda.zhang.q@gmail.com>
 		2014-02-24 09:47:46 -06:00
api-guide Add stub files for new API Guide 2014-02-24 09:47:46 -06:00
api-quick-start Remove references to '24 hour' tokens 2014-01-22 13:31:28 -06:00
api-ref Merge "Fix WADL errors - part of JSON validation" 2014-02-23 15:10:18 +00:00
www The API site includes the Networking API calls 2014-02-10 12:02:25 -05:00
.gitignore doc-tools: Ignore build-.log.gz 2014-02-08 22:09:09 +01:00
.gitreview Complete api-site split from openstack-manuals. 2012-09-25 10:20:38 -07:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Fix bullet list format in README.rst 2014-02-02 11:16:53 +01:00
doc-test.conf Update comment about API Ref publishing 2014-02-22 19:46:54 +01:00
pom.xml Add stub files for new API Guide 2014-02-24 09:47:46 -06:00
test-requirements.txt Updated from global requirements 2014-02-20 01:36:16 +00:00
tox.ini Set up for publishing via openstack-doc-tools 2014-02-14 16:47:00 +01:00

README.rst

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 maven

On Fedora 15 and later:

yum install maven3

Building

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-sources

The generated PDF documentation file is:

api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/api-quick-start-onepager.pdf

The root of the generated HTML documentation is:

api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/content/index.html

Testing 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 tests
  • tox -e checksyntax - to run syntax checks
  • tox -e checkdeletions - to check that no deleted files are referenced
  • tox -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:

https://bugs.launchpad.net/openstack-api-site/

Installing

Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.