openstack-attic/netconn-api
Code Issues Proposed changes
175 Commits 1 Branch 3 Tags 3.1 MiB
JavaScript 44.7%
XSLT 37.5%
CSS 16.2%
Shell 1.6%
c486805546
Go to file
Ramaraja c486805546 Word "not" missing from Networking API v2.0 
Added "not" after "does"
Closes-Bug: #1371349
Change-Id: Icd42778a78b0df3081f865e44f25d484ba2a2da6
2014-09-23 17:29:34 +00:00
tools Add rfc.sh to help with gerrit workflow. 2011-09-29 16:19:20 -07:00
v1.0 Merge "Fix various typos" 2014-05-03 03:42:03 +00:00
v2.0 Word "not" missing from Networking API v2.0 2014-09-23 17:29:34 +00:00
.gitignore doc-tools: Ignore build-*.log.gz 2014-02-08 22:11:13 +01:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:48:29 -04:00
doc-test.conf Rebuild 1.0 so that JSON fixes are picked up 2014-05-01 18:41:30 +02:00
pom.xml Update to clouddocs-maven-plugin 2.1.1 2014-07-02 16:05:36 -05:00
README.rst Fix bullet list format in README.rst 2014-02-02 12:19:47 +01:00
test-requirements.txt Setup for openstack-doc-tools 2014-01-09 20:14:32 +01:00
tox.ini Add new checklinks tox environment 2014-08-16 12:07:14 +02: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

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.

Installing

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