]> review.fuel-infra Code Review - openstack-build/neutron-build.git/commit
Start of new developer documentation
authorJay Pipes <jaypipes@gmail.com>
Thu, 26 Dec 2013 21:04:19 +0000 (16:04 -0500)
committerJay Pipes <jaypipes@gmail.com>
Thu, 26 Dec 2013 22:24:38 +0000 (17:24 -0500)
commitde38cdafaa9183c3c27fcc13c8e28ddaff5c2aa3
tree29f954e5ff06fe99736b79db9aa7162d7e4df02f
parent84aeb9a407cde367ff4d6e2b5986dd0a689bc332
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
doc/source/devref/development.environment.rst [new file with mode: 0644]
doc/source/devref/index.rst
doc/source/index.rst