vmware-nsx/doc/source/index.rst
Jay Pipes de38cdafaa Start of new developer documentation
There is currently no useful developer-focused documentation in-tree
for Neutron. There are a smattering of useful documents on the
OpenStack wiki, however, there isn't a good organization to this
information, nor is there a condensed developer focus to a lot of it.
Some of the wiki pages are more proposals for features or bug fixes,
and there is a need for architecture, design, and code walk-through
documentation for Neutron to help with new (and existing) contribution.

This patch begins the process of adding developer documentation to Neutron.
It updates the main developer reference index.rst to pull in-line with what
Nova is doing, leaving some todo references for future patches. It also
adds a development.environment tutorial that is up-to-date with current
Neutron development, using tox/testr processes for running unit tests and
including a number of references to external wiki pages that have
instructions for using DevStack for OpenStack contribution/testing.

The next series of patches will add automodule documentation to the
developer reference for some of the major modules in Neutron.

Change-Id: I23aaa11d9a174f24242c49767b92540f5e25b48a
Addresses: blueprint quantum-developer-docs
2013-12-26 17:24:38 -05:00

2.0 KiB

Welcome to Neutron's developer documentation!

Neutron is an OpenStack project to provide "network connectivity as a service" between interface devices (e.g., vNICs) managed by other Openstack services (e.g., nova). It implements the Neutron API.

This document describes Neutron for contributors of the project, and assumes that you are already familiar with Neutron from an end-user perspective.

This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on Neutron and other components of OpenStack can be found on the OpenStack wiki and the Neutron section of the wiki. The Neutron Development wiki is also a good resource for new contributors.

Enjoy!

Developer Docs

devref/index

API Extensions

Go to http://api.openstack.org for information about OpenStack Network API extensions.

Man Pages

man/neutron-server