neutron/doc/source/index.rst
armando-migliaccio eb5c66c36a Delete stale neutron-server manual
The configuration options come from oslo and the server
executable is usually wrapped in a service script, supplied
by packagers and/or deployment tools. Any extra documentation
available in tree is of relative value, and the fact that
this file has been virtually ignored ever since it was
added is a testament of that.

Let's stop its agony and wish it to rest in peace.

Closes-bug: #1520041

Change-Id: If5bba557526903b8064ee28628a21c3459ca85bc
2015-12-04 18:43:28 -08:00

81 lines
2.3 KiB
ReStructuredText

..
Copyright 2011-2013 OpenStack Foundation
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
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`_.
.. _`Neutron API`: http://docs.openstack.org/api/openstack-network/2.0/content/
This document describes Neutron for contributors of the project, and assumes
that you are already familiar with Neutron from an `end-user perspective`_.
.. _`end-user perspective`: http://docs.openstack.org/trunk/openstack-network/admin/content/index.html
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.
.. _`OpenStack wiki`: http://wiki.openstack.org
.. _`Neutron section of the wiki`: http://wiki.openstack.org/Neutron
.. _`Neutron Development wiki`: http://wiki.openstack.org/NeutronDevelopment
Enjoy!
Neutron Policies
================
.. toctree::
:maxdepth: 2
policies/index
Neutron Stadium
===============
.. toctree::
:maxdepth: 2
stadium/index
Developer Docs
==============
.. toctree::
:maxdepth: 3
devref/index
Dashboards
==========
There is a collection of dashboards to help developers and reviewers
located here.
.. toctree::
:maxdepth: 2
dashboards/index
API Extensions
==============
Go to http://api.openstack.org for information about OpenStack Network API extensions.