de38cdafaa
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 |
||
|---|---|---|
| bin | ||
| doc | ||
| etc | ||
| neutron | ||
| quantum | ||
| tools | ||
| .coveragerc | ||
| .gitignore | ||
| .gitreview | ||
| .mailmap | ||
| .pylintrc | ||
| .testr.conf | ||
| HACKING.rst | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.rst | ||
| TESTING | ||
| babel.cfg | ||
| openstack-common.conf | ||
| requirements.txt | ||
| run_tests.sh | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
README.rst
# -- Welcome!
You have come across a cloud computing network fabric controller. It has identified itself as "Neutron." It aims to tame your (cloud) networking!
# -- External Resources:
The homepage for Neutron is: http://launchpad.net/neutron . Use this site for asking for help, and filing bugs. Code is available on github at <http://github.com/openstack/neutron>.
The latest and most in-depth documentation on how to use Neutron is available at: <http://docs.openstack.org>. This includes:
Neutron Administrator Guide http://docs.openstack.org/trunk/openstack-network/admin/content/
Neutron API Reference: http://docs.openstack.org/api/openstack-network/2.0/content/
The start of some developer documentation is available at: http://wiki.openstack.org/NeutronDevelopment
For help using or hacking on Neutron, you can send mail to <mailto:openstack-dev@lists.openstack.org>.