openstack-attic/netconn-api
Code Issues Proposed changes
86 Commits 1 Branch 3 Tags 3.1 MiB
JavaScript 44.7%
XSLT 37.5%
CSS 16.2%
Shell 1.6%
b367816883
Go to file
Sam Harwell b367816883 Fix syntax errors in JSON examples 
Many documentation samples include JSON which is not syntactically
valid. This change does not verify that the JSON samples included in
project are correct or used, but merely corrects the obviously invalid
sections of code.

Change-Id: I8539be30d41207befda004017664099471f28ab5
2013-11-26 09:48:26 -06:00
tools Add rfc.sh to help with gerrit workflow. 2011-09-29 16:19:20 -07:00
v1.0 Fix syntax errors in JSON examples 2013-11-26 09:48:26 -06:00
v2.0 Fix syntax errors in JSON examples 2013-11-26 09:48:26 -06:00
.gitignore Added new Quantum API v2 book 2012-08-20 15:53:46 -05:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:48:29 -04:00
pom.xml Add parent pom and update to clouddocs 1.12.0 2013-11-22 10:04:35 +01:00
README.rst Update filepath of build instructions in README.rst 2013-10-26 18:48:25 +09:00

README.rst

Netconn API

This repository contains the RESTful API information for the OpenStack Network Connectivity project, also known as Neutron. The Neutron project provides open source network connectivity to OpenStack Compute, the project named Nova.

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.

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

To build:

cd v2.0
mvn clean generate-sources

The generated PDF documentation file is:

v2.0/target/docbkx/webhelp/openstack-network/openstack-network.pdf

The root of the generated HTML documentation is:

v2.0/target/docbkx/webhelp/openstack-network/index.html

Installing

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