5c0f28bd88
This patch is in response to prior discussion in the weekly IRC team meeting. The patch does not actually add any documentation (apart from the bits on testing and dev env setup). It does propose topics in the index.rst for documents that need to added for the existing components. These will be added by the team as follow-up patches. For any patch that adds a new feature or modifies an existing feature it will be required to submit a devref rst document as a part of that patch. This document should be posted in the doc/source/devref/ location. There isn's a specific format for the document, but it is expected that the document adequately explains the design of the feature that is being implemented such that its easy for the rest of the team to review, maintain, and enhance the implementation. Change-Id: Ifc32c330d754f623c403fb0c9a5f5c639cce41db
61 lines
1.4 KiB
ReStructuredText
61 lines
1.4 KiB
ReStructuredText
..
|
|
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
|
|
implementation of Group Based Policy's software components.
|
|
|
|
|
|
Programming HowTos and Tutorials
|
|
--------------------------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
development.environment
|
|
|
|
|
|
GBP Design
|
|
----------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
gbp_resource_model
|
|
gbp_plugin_and_driver_architecture
|
|
gbp_driver_extensions
|
|
implicit_mapping_policy_driver
|
|
resource_mapping_policy_driver
|
|
gbp_external_connectivity
|
|
gbp_service_chaining_model
|
|
gbp_node_composition_plugin_and_driver_architecture
|
|
gbp_traffic_stitching_plumber
|
|
|
|
|
|
Module Reference
|
|
----------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
.. todo::
|
|
|
|
Add in all the big modules as automodule indexes.
|
|
|
|
|
|
Indices and tables
|
|
------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|