openstack-attic/netconn-api
Code Issues Proposed changes
181 Commits 1 Branch 3 Tags 3.1 MiB
JavaScript 44.7%
XSLT 37.5%
CSS 16.2%
Shell 1.6%
master
Go to file
OpenDev Sysadmins 42f7afc85f OpenDev Migration Patch 
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:26:11 +00:00
tools Workflow documentation is now in infra-manual 2014-12-05 03:30:37 +00: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 OpenDev Migration Patch 2019-04-19 19:26:11 +00: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.3 2014-09-22 19:58:48 +02:00
README.rst Indicates frozen nature in README 2014-12-12 12:14:23 -06: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 is now frozen-in-time and will not accept new patches. To update Networking API information, please submit patches to http://git.openstack.org/cgit/openstack/neutron-specs for a new API feature and to http://git.openstack.org/cgit/openstack/api-site for implemented API information.

It was the original holder for API information for the OpenStack Networking

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.