openstack-attic/netconn-api
Code Issues Proposed changes

Cleanup README and add build instructions

Browse Source 
This patch cleans up the README file to match that of openstack-manuals
and adds build instuctions.

Change-Id: I77000420bac19fad375d04adf3c0dacf20df65d4
This commit is contained in:
Aaron Rosen 2013-09-19 11:01:26 -07:00
parent 7208477870
commit 8d9fbecd1f
1 changed files with 42 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.rst
View File

@ -1,9 +1,48 @@
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.
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.
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 <http://maven.apache.org/>`_ 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 netconn-api
mvn clean generate-sources
The generated PDF documentation file is::
netconn-api/target/docbkx/webhelp/api/openstack-network/2.0/neutron-api-guide-2.0.pdf
The root of the generated HTML documentation is::
netconn-api/target/docbkx/webhelp/api/openstack-network/2.0/index.html
Installing
==========
Refer to http://docs.openstack.org/incubation to learn more about installing OpenStack Neutron so that you can test these API commands.
Refer to http://docs.openstack.org to see where these documents are published
and to learn more about the OpenStack project.