neutron/doc/source/index.rst
Kyle Mestery 2486842857 Move Neutron Policy pages into the tree
The information from the NeutronPolicies wiki page [1] is useful. But
having it in a static wiki is less so. Moving this into the Neutron
documentation in-tree will allow for an easier maintenance of this
information.

[1] https://wiki.openstack.org/wiki/NeutronPolicies

Change-Id: I23cada04031e00f48c0f6dc26a992ed204195526
2015-03-05 15:53:21 -05:00

69 lines
2.1 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: 1
policies/index
Developer Docs
==============
.. toctree::
:maxdepth: 1
devref/index
API Extensions
==============
Go to http://api.openstack.org for information about OpenStack Network API extensions.
Man Pages
---------
.. toctree::
man/neutron-server