From cf6cf44e4ba589ddf85749bca8ec1a2ec9df7243 Mon Sep 17 00:00:00 2001 From: "vikram.choudhary" Date: Thu, 28 Apr 2016 16:53:25 +0530 Subject: [PATCH] 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 --- README.rst | 17 +++--- doc/source/contributing.rst | 24 +++++++++ doc/source/design/agent-scheduler.rst | 28 ++++++++++ doc/source/design/api.rst | 28 ++++++++++ doc/source/design/command-lines.rst | 28 ++++++++++ doc/source/design/drivers.rst | 28 ++++++++++ doc/source/design/system-design.rst | 28 ++++++++++ doc/source/functionality/bgp-speaker.rst | 28 ++++++++++ .../functionality/route-advertisement.rst | 28 ++++++++++ doc/source/index.rst | 54 ++++++++++++++++--- doc/source/installation.rst | 24 +++++++++ doc/source/others/alembic_migration.rst | 28 ++++++++++ doc/source/others/testing.rst | 28 ++++++++++ doc/source/usage.rst | 28 +++++++++- 14 files changed, 380 insertions(+), 19 deletions(-) create mode 100644 doc/source/design/agent-scheduler.rst create mode 100644 doc/source/design/api.rst create mode 100644 doc/source/design/command-lines.rst create mode 100644 doc/source/design/drivers.rst create mode 100644 doc/source/design/system-design.rst create mode 100644 doc/source/functionality/bgp-speaker.rst create mode 100644 doc/source/functionality/route-advertisement.rst create mode 100644 doc/source/others/alembic_migration.rst create mode 100644 doc/source/others/testing.rst diff --git a/README.rst b/README.rst index 68c4e5bd..4a17144c 100644 --- a/README.rst +++ b/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: -. + -Please refer to Neutron documentation for more information: +Refer to Neutron documentation for more information: `Neutron README.rst `_ diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 1728a61c..73ba2513 100644 --- a/doc/source/contributing.rst +++ b/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 ============ diff --git a/doc/source/design/agent-scheduler.rst b/doc/source/design/agent-scheduler.rst new file mode 100644 index 00000000..ca83d14d --- /dev/null +++ b/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 diff --git a/doc/source/design/api.rst b/doc/source/design/api.rst new file mode 100644 index 00000000..fb8c2062 --- /dev/null +++ b/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 diff --git a/doc/source/design/command-lines.rst b/doc/source/design/command-lines.rst new file mode 100644 index 00000000..839d3b8d --- /dev/null +++ b/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 diff --git a/doc/source/design/drivers.rst b/doc/source/design/drivers.rst new file mode 100644 index 00000000..308cff94 --- /dev/null +++ b/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 diff --git a/doc/source/design/system-design.rst b/doc/source/design/system-design.rst new file mode 100644 index 00000000..6a3e4b78 --- /dev/null +++ b/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 diff --git a/doc/source/functionality/bgp-speaker.rst b/doc/source/functionality/bgp-speaker.rst new file mode 100644 index 00000000..5400d971 --- /dev/null +++ b/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 diff --git a/doc/source/functionality/route-advertisement.rst b/doc/source/functionality/route-advertisement.rst new file mode 100644 index 00000000..be35f4e5 --- /dev/null +++ b/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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 336adebb..8cc2a711 100644 --- a/doc/source/index.rst +++ b/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 -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:: :maxdepth: 2 - readme - installation - usage - contributing + design/system-design + design/api + design/command-lines + 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 ================== @@ -40,4 +81,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 20a2bc81..c58e1563 100644 --- a/doc/source/installation.rst +++ b/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 ============ diff --git a/doc/source/others/alembic_migration.rst b/doc/source/others/alembic_migration.rst new file mode 100644 index 00000000..7d6a57c3 --- /dev/null +++ b/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 diff --git a/doc/source/others/testing.rst b/doc/source/others/testing.rst new file mode 100644 index 00000000..ed3afc74 --- /dev/null +++ b/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 diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 52a9a3dc..b3e3129d 100644 --- a/doc/source/usage.rst +++ b/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::