Documentation

This patch restructures existing documents for better user
experience.

Below changes are done as part of this patch-set:
 - Re-structured/Reworded existing documents.
 - Identified and added dummy documents for required devrefs.

Implements: blueprint bgp-spinout
Partial-Bug: #1560003

Change-Id: I71d9f6107bca165d72b6f6e710ac6e0e6108fcf9
This commit is contained in:
vikram.choudhary 2016-04-28 16:53:25 +05:30
parent 4ba80f3f1c
commit cf6cf44e4b
14 changed files with 380 additions and 19 deletions

View File

@ -1,18 +1,15 @@
Welcome! This package contains neutron-dynamic-routing code which depends upon neutron
======== and it's related libraries to run.
This package contains the code for the Neutron dynamic routing. This package External Resources
requires Neutron to run. ==================
External Resources:
===================
The homepage for Neutron is: http://launchpad.net/neutron. Use this The homepage for Neutron is: http://launchpad.net/neutron. Use this
site for asking for help, and filing bugs. We use a single Launchpad site for asking for help, and filing bugs. We use a single launchpad
page for all Neutron projects. page for all Neutron projects.
Code is available on git.openstack.org at: Code is available on git.openstack.org at:
<http://git.openstack.org/cgit/openstack/neutron-dynamic-routing>. <http://git.openstack.org/cgit/openstack/neutron-dynamic-routing>
Please refer to Neutron documentation for more information: Refer to Neutron documentation for more information:
`Neutron README.rst <http://git.openstack.org/cgit/openstack/neutron/tree/README.rst>`_ `Neutron README.rst <http://git.openstack.org/cgit/openstack/neutron/tree/README.rst>`_

View File

@ -1,3 +1,27 @@
..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
============ ============
Contributing Contributing
============ ============

View File

@ -0,0 +1,28 @@
..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
Agent & Scheduler
=================
TODO: Coming Soon

28
doc/source/design/api.rst Normal file
View File

@ -0,0 +1,28 @@
..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
API
===
TODO: Coming Soon

View File

@ -0,0 +1,28 @@
..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
Command Lines
=============
TODO: Coming Soon

View File

@ -0,0 +1,28 @@
..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
Drivers
=======
TODO: Coming Soon

View File

@ -0,0 +1,28 @@
..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
System Design
=============
TODO: Coming Soon

View File

@ -0,0 +1,28 @@
..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
BGP Speaker
===========
TODO: Coming Soon

View File

@ -0,0 +1,28 @@
..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
Route Advertisement
===================
TODO: Coming Soon

View File

@ -1,5 +1,5 @@
.. ..
Copyright 2016 Huawei India Pvt Ltd. All rights reserved. Copyright 2016 Huawei Technologies India Pvt Limited.
Licensed under the Apache License, Version 2.0 (the "License"); you may 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 not use this file except in compliance with the License. You may obtain
@ -13,6 +13,7 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
Convention for heading levels in Neutron devref: Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document) ======= Heading 0 (reserved for the title in a document)
------- Heading 1 ------- Heading 1
@ -23,16 +24,56 @@
Welcome to neutron-dynamic-routing's documentation! Welcome to neutron-dynamic-routing's documentation!
=================================================== ===================================================
.. include:: ../../README.rst
Contents:
===============
Developer Guide
===============
In the Developer Guide, you will find information on neutron-dynamic-routing
lower level programming APIs. There are sections that cover the core pieces
of neutron-dynamic-routing, including its api, command-lines, database,
system-design, alembic-migration etc. There are also subsections that describe
specific drivers inside neutron-dynamic-routing. Finally, the developer guide
includes information about testing and supported functionalities as well. This
documentation is generated by the Sphinx toolkit and lives in the source
tree.
Programming HowTos and Tutorials
--------------------------------
.. toctree::
:maxdepth: 2
installation
usage
contributing
Design
------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
readme design/system-design
installation design/api
usage design/command-lines
contributing design/agent-scheduler
design/drivers
Functionality
-------------
.. toctree::
:maxdepth: 2
functionality/bgp-speaker
functionality/route-advertisement
Others
------
.. toctree::
:maxdepth: 2
others/alembic_migration
others/testing
Indices and tables Indices and tables
================== ==================
@ -40,4 +81,3 @@ Indices and tables
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`
* :ref:`search` * :ref:`search`

View File

@ -1,3 +1,27 @@
..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
============ ============
Installation Installation
============ ============

View File

@ -0,0 +1,28 @@
..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
Alembic-migration
=================
TODO: Coming Soon

View File

@ -0,0 +1,28 @@
..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
Testing
=======
TODO: Coming Soon

View File

@ -1,6 +1,30 @@
======== ..
Copyright 2016 Huawei Technologies India Pvt Limited.
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.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
=====
Usage Usage
======== =====
To use neutron-dynamic-routing in a project:: To use neutron-dynamic-routing in a project::