Browse Source

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
changes/35/310735/4
vikram.choudhary 5 years ago
parent
commit
cf6cf44e4b
  1. 17
      README.rst
  2. 24
      doc/source/contributing.rst
  3. 28
      doc/source/design/agent-scheduler.rst
  4. 28
      doc/source/design/api.rst
  5. 28
      doc/source/design/command-lines.rst
  6. 28
      doc/source/design/drivers.rst
  7. 28
      doc/source/design/system-design.rst
  8. 28
      doc/source/functionality/bgp-speaker.rst
  9. 28
      doc/source/functionality/route-advertisement.rst
  10. 54
      doc/source/index.rst
  11. 24
      doc/source/installation.rst
  12. 28
      doc/source/others/alembic_migration.rst
  13. 28
      doc/source/others/testing.rst
  14. 28
      doc/source/usage.rst

17
README.rst

@ -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
requires Neutron to run.
External Resources:
===================
External Resources
==================
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.
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>`_

24
doc/source/contributing.rst

@ -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
============

28
doc/source/design/agent-scheduler.rst

@ -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

@ -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

28
doc/source/design/command-lines.rst

@ -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

28
doc/source/design/drivers.rst

@ -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

28
doc/source/design/system-design.rst

@ -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

28
doc/source/functionality/bgp-speaker.rst

@ -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

28
doc/source/functionality/route-advertisement.rst

@ -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

54
doc/source/index.rst

@ -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
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
under the License.
Convention for heading levels in Neutron devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
@ -23,16 +24,56 @@
Welcome to neutron-dynamic-routing's documentation!
===================================================
.. include:: ../../README.rst
===============
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::
:maxdepth: 2
Contents:
design/system-design
design/api
design/command-lines
design/agent-scheduler
design/drivers
Functionality
-------------
.. toctree::
:maxdepth: 2
readme
installation
usage
contributing
functionality/bgp-speaker
functionality/route-advertisement
Others
------
.. toctree::
:maxdepth: 2
others/alembic_migration
others/testing
Indices and tables
==================
@ -40,4 +81,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

24
doc/source/installation.rst

@ -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
============

28
doc/source/others/alembic_migration.rst

@ -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

28
doc/source/others/testing.rst

@ -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

28
doc/source/usage.rst

@ -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
========
=====
To use neutron-dynamic-routing in a project::

Loading…
Cancel
Save