18f3915374
This wasn't setup in the reppo, so I'm adding it now. Empty for now, with TODOs for some sections. The "tox -e docs" was updated to generate the documentation. Change-Id: I17e475b2a870a1ecdb2a1cacf2087a96beac3f78
76 lines
1.8 KiB
ReStructuredText
76 lines
1.8 KiB
ReStructuredText
..
|
|
Copyright 2015 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.
|
|
|
|
Developer Guide
|
|
===============
|
|
|
|
In the Developer Guide, you will find information on the design, and
|
|
architecture of the Neutron Virtual Private Network as a Service repo.
|
|
This include things like, information on the reference implementation
|
|
flavors, design details on VPNaaS internals, and testing. Developers
|
|
will extend this, as needed, in the future to contain more information.
|
|
|
|
|
|
VPNaaS Flavors
|
|
-----------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
.. todo::
|
|
|
|
Info on the different Swan flavors, how they are different, and what
|
|
Operating Systems support them.
|
|
|
|
|
|
VPNaaS Internals
|
|
-----------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
.. todo::
|
|
|
|
Add design details about VPN, especially items that are not obvious.
|
|
Can indication restrictions/limitations.
|
|
|
|
|
|
Testing
|
|
-------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
.. todo::
|
|
|
|
Add notes about functional testing, with info on how
|
|
different reference drivers are tested.
|
|
|
|
|
|
Module Reference
|
|
----------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
.. todo::
|
|
|
|
Add in all the big modules as automodule indexes.
|
|
|
|
|
|
Indices and tables
|
|
------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|