Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

Use --publish for openstack-doc-test

This requires openstack-doc-test 0.11: We now can use --publish for
openstack-doc-test. This replaces --nocreate-index.

Change-Id: I5d1929639235d4f9d64303d06b2ba31b819cc54d
latest commit 15252671f2
Andreas Jaeger ajaeger authored April 19, 2014
Octocat-spinner-32 incubation Update to clouddocs-maven-plugin 1.15 March 21, 2014
Octocat-spinner-32 openstack-compute-api-1.0 Update to clouddocs-maven-plugin 1.15 March 21, 2014
Octocat-spinner-32 openstack-compute-api-2 Clarity and sentences amend two April 08, 2014
Octocat-spinner-32 tools Add rfc.sh to help with gerrit workflow. September 13, 2011
Octocat-spinner-32 .gitignore doc-tools: Ignore build-*.log.gz February 08, 2014
Octocat-spinner-32 .gitreview Add .gitreview config file for gerrit. October 20, 2011
Octocat-spinner-32 README.rst Fix bullet list format in README.rst February 02, 2014
Octocat-spinner-32 doc-test.conf Set up for publishing via openstack-doc-tools February 14, 2014
Octocat-spinner-32 test-requirements.txt Updated from global requirements April 19, 2014
Octocat-spinner-32 tox.ini Use --publish for openstack-doc-test April 19, 2014
README.rst

Compute API

This repository contains the RESTful API information for the OpenStack Compute project, also known as Nova. The Nova project provides open source cloud management and orchestration services.

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 incubation, openstack-compute-api-1.0 and openstack-compute-api-2 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 openstack-compute-api-2
mvn clean generate-sources

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 there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through Launchpad, the OpenStack wiki, or blogs. We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

Installing

Refer to http://docs.openstack.org to learn more about installing an OpenStack Compute server that can respond to these API commands.

Something went wrong with that request. Please try again.