From fa53c16b5e11096ccbc5727876ab3f8257d9035f Mon Sep 17 00:00:00 2001 From: Dongfeng Huang Date: Tue, 25 Jul 2017 11:54:56 +0800 Subject: [PATCH] [doc-migration] Reorganize the Tricircle doc/source folder 1. What is the problem Doc migration requires that the installation, admin and configuration guides have to be put into related directories. 2. What is the solution for the problem Put configuration, install and admin guide into related sub-folders. 3. What the features need to be implemented to the tricircle to realize the solution None. Closes-Bug: #1706190 Change-Id: I1e1909a373e92b29460b364de38cc25aba038776 --- doc/source/{ => admin}/api_v1.rst | 0 doc/source/admin/cli.rst | 3 ++ doc/source/admin/index.rst | 9 ++++ .../{ => configuration}/configuration.rst | 0 doc/source/configuration/index.rst | 8 +++ doc/source/contributing.rst | 4 -- doc/source/contributor/contributing.rst | 4 ++ doc/source/contributor/index.rst | 8 +++ doc/source/index.rst | 50 +++++++++++++------ doc/source/install/index.rst | 8 +++ .../{ => install}/installation-cell.rst | 0 .../{ => install}/installation-guide.rst | 0 .../{ => install}/installation-manual.rst | 0 .../multi-pod-installation-devstack.rst | 0 .../single-pod-installation-devstack.rst | 0 doc/source/networking/index.rst | 8 +++ ...working-guide-direct-provider-networks.rst | 0 .../networking-guide-local-networking.rst | 0 ...rking-guide-multiple-external-networks.rst | 0 ...king-guide-multiple-ns-with-ew-enabled.rst | 0 ...tworking-guide-single-external-network.rst | 0 .../{ => networking}/networking-guide.rst | 2 + .../networking-prerequisites.rst | 0 .../{ => networking}/networking-scenarios.rst | 2 +- .../{ => networking}/networking-terms.rst | 0 .../service-function-chaining-guide.rst | 0 .../{ => networking}/vlan-aware-vms-guide.rst | 0 doc/source/readme.rst | 1 - doc/source/user/index.rst | 9 ++++ doc/source/user/readme.rst | 2 + doc/source/{ => user}/usage.rst | 4 +- index.rst | 44 ++++++++++++++++ 32 files changed, 142 insertions(+), 24 deletions(-) rename doc/source/{ => admin}/api_v1.rst (100%) create mode 100644 doc/source/admin/cli.rst create mode 100644 doc/source/admin/index.rst rename doc/source/{ => configuration}/configuration.rst (100%) create mode 100644 doc/source/configuration/index.rst delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/contributing.rst create mode 100644 doc/source/contributor/index.rst create mode 100644 doc/source/install/index.rst rename doc/source/{ => install}/installation-cell.rst (100%) rename doc/source/{ => install}/installation-guide.rst (100%) rename doc/source/{ => install}/installation-manual.rst (100%) rename doc/source/{ => install}/multi-pod-installation-devstack.rst (100%) rename doc/source/{ => install}/single-pod-installation-devstack.rst (100%) create mode 100644 doc/source/networking/index.rst rename doc/source/{ => networking}/networking-guide-direct-provider-networks.rst (100%) rename doc/source/{ => networking}/networking-guide-local-networking.rst (100%) rename doc/source/{ => networking}/networking-guide-multiple-external-networks.rst (100%) rename doc/source/{ => networking}/networking-guide-multiple-ns-with-ew-enabled.rst (100%) rename doc/source/{ => networking}/networking-guide-single-external-network.rst (100%) rename doc/source/{ => networking}/networking-guide.rst (81%) rename doc/source/{ => networking}/networking-prerequisites.rst (100%) rename doc/source/{ => networking}/networking-scenarios.rst (94%) rename doc/source/{ => networking}/networking-terms.rst (100%) rename doc/source/{ => networking}/service-function-chaining-guide.rst (100%) rename doc/source/{ => networking}/vlan-aware-vms-guide.rst (100%) delete mode 100644 doc/source/readme.rst create mode 100644 doc/source/user/index.rst create mode 100644 doc/source/user/readme.rst rename doc/source/{ => user}/usage.rst (81%) create mode 100644 index.rst diff --git a/doc/source/api_v1.rst b/doc/source/admin/api_v1.rst similarity index 100% rename from doc/source/api_v1.rst rename to doc/source/admin/api_v1.rst diff --git a/doc/source/admin/cli.rst b/doc/source/admin/cli.rst new file mode 100644 index 00000000..c60c82cc --- /dev/null +++ b/doc/source/admin/cli.rst @@ -0,0 +1,3 @@ +================================ +Command-Line Interface Reference +================================ \ No newline at end of file diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst new file mode 100644 index 00000000..fc51a9d2 --- /dev/null +++ b/doc/source/admin/index.rst @@ -0,0 +1,9 @@ +===================== +Tricircle Admin Guide +===================== + +.. toctree:: + :maxdepth: 3 + + api_v1 + cli diff --git a/doc/source/configuration.rst b/doc/source/configuration/configuration.rst similarity index 100% rename from doc/source/configuration.rst rename to doc/source/configuration/configuration.rst diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst new file mode 100644 index 00000000..4f7dcb22 --- /dev/null +++ b/doc/source/configuration/index.rst @@ -0,0 +1,8 @@ +============================= +Tricircle Configuration Guide +============================= + +.. toctree:: + :maxdepth: 3 + + configuration diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index dbb79b45..00000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============= -Contributing -============= -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 00000000..2aa07077 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,4 @@ +============ +Contributing +============ +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 00000000..1ae43b76 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,8 @@ +============================ +Tricircle Contribution Guide +============================ + +.. toctree:: + :maxdepth: 1 + + contributing diff --git a/doc/source/index.rst b/doc/source/index.rst index 1ebdecf2..8162f2db 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,26 +7,44 @@ Welcome to Tricircle's documentation! ===================================== -Contents -======== - +Tricircle User Guide +==================== .. toctree:: :maxdepth: 3 - readme - usage - installation-guide - configuration - networking-guide - vlan-aware-vms-guide - service-function-chaining-guide - api_v1 - contributing + user/index +Tricircle Contribution Guide +============================ +.. toctree:: + :maxdepth: 2 + contributor/index -Indices and tables -================== +Tricircle Admin Guide +===================== +.. toctree:: + :maxdepth: 3 -* :ref:`genindex` -* :ref:`search` + admin/index + +Tricircle Installation Guide +============================ +.. toctree:: + :maxdepth: 3 + + install/index + +Tricircle Configuration Guide +============================= +.. toctree:: + :maxdepth: 3 + + configuration/index + +Tricircle Networking Guide +========================== +.. toctree:: + :maxdepth: 4 + + networking/index \ No newline at end of file diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst new file mode 100644 index 00000000..a42975e8 --- /dev/null +++ b/doc/source/install/index.rst @@ -0,0 +1,8 @@ +============================ +Tricircle Installation Guide +============================ + +.. toctree:: + :maxdepth: 3 + + installation-guide diff --git a/doc/source/installation-cell.rst b/doc/source/install/installation-cell.rst similarity index 100% rename from doc/source/installation-cell.rst rename to doc/source/install/installation-cell.rst diff --git a/doc/source/installation-guide.rst b/doc/source/install/installation-guide.rst similarity index 100% rename from doc/source/installation-guide.rst rename to doc/source/install/installation-guide.rst diff --git a/doc/source/installation-manual.rst b/doc/source/install/installation-manual.rst similarity index 100% rename from doc/source/installation-manual.rst rename to doc/source/install/installation-manual.rst diff --git a/doc/source/multi-pod-installation-devstack.rst b/doc/source/install/multi-pod-installation-devstack.rst similarity index 100% rename from doc/source/multi-pod-installation-devstack.rst rename to doc/source/install/multi-pod-installation-devstack.rst diff --git a/doc/source/single-pod-installation-devstack.rst b/doc/source/install/single-pod-installation-devstack.rst similarity index 100% rename from doc/source/single-pod-installation-devstack.rst rename to doc/source/install/single-pod-installation-devstack.rst diff --git a/doc/source/networking/index.rst b/doc/source/networking/index.rst new file mode 100644 index 00000000..a9b06174 --- /dev/null +++ b/doc/source/networking/index.rst @@ -0,0 +1,8 @@ +========================== +Tricircle Networking Guide +========================== + +.. toctree:: + :maxdepth: 4 + + networking-guide diff --git a/doc/source/networking-guide-direct-provider-networks.rst b/doc/source/networking/networking-guide-direct-provider-networks.rst similarity index 100% rename from doc/source/networking-guide-direct-provider-networks.rst rename to doc/source/networking/networking-guide-direct-provider-networks.rst diff --git a/doc/source/networking-guide-local-networking.rst b/doc/source/networking/networking-guide-local-networking.rst similarity index 100% rename from doc/source/networking-guide-local-networking.rst rename to doc/source/networking/networking-guide-local-networking.rst diff --git a/doc/source/networking-guide-multiple-external-networks.rst b/doc/source/networking/networking-guide-multiple-external-networks.rst similarity index 100% rename from doc/source/networking-guide-multiple-external-networks.rst rename to doc/source/networking/networking-guide-multiple-external-networks.rst diff --git a/doc/source/networking-guide-multiple-ns-with-ew-enabled.rst b/doc/source/networking/networking-guide-multiple-ns-with-ew-enabled.rst similarity index 100% rename from doc/source/networking-guide-multiple-ns-with-ew-enabled.rst rename to doc/source/networking/networking-guide-multiple-ns-with-ew-enabled.rst diff --git a/doc/source/networking-guide-single-external-network.rst b/doc/source/networking/networking-guide-single-external-network.rst similarity index 100% rename from doc/source/networking-guide-single-external-network.rst rename to doc/source/networking/networking-guide-single-external-network.rst diff --git a/doc/source/networking-guide.rst b/doc/source/networking/networking-guide.rst similarity index 81% rename from doc/source/networking-guide.rst rename to doc/source/networking/networking-guide.rst index c555be43..55f99ee3 100644 --- a/doc/source/networking-guide.rst +++ b/doc/source/networking/networking-guide.rst @@ -10,3 +10,5 @@ typical networking mode will be described. .. include:: ./networking-terms.rst .. include:: ./networking-prerequisites.rst .. include:: ./networking-scenarios.rst +.. include:: ./service-function-chaining-guide.rst +.. include:: ./vlan-aware-vms-guide.rst diff --git a/doc/source/networking-prerequisites.rst b/doc/source/networking/networking-prerequisites.rst similarity index 100% rename from doc/source/networking-prerequisites.rst rename to doc/source/networking/networking-prerequisites.rst diff --git a/doc/source/networking-scenarios.rst b/doc/source/networking/networking-scenarios.rst similarity index 94% rename from doc/source/networking-scenarios.rst rename to doc/source/networking/networking-scenarios.rst index 29755c57..3966ea33 100644 --- a/doc/source/networking-scenarios.rst +++ b/doc/source/networking/networking-scenarios.rst @@ -3,7 +3,7 @@ Networking Scenario =================== .. toctree:: - :maxdepth: 3 + :maxdepth: 4 networking-guide-direct-provider-networks.rst networking-guide-multiple-external-networks.rst diff --git a/doc/source/networking-terms.rst b/doc/source/networking/networking-terms.rst similarity index 100% rename from doc/source/networking-terms.rst rename to doc/source/networking/networking-terms.rst diff --git a/doc/source/service-function-chaining-guide.rst b/doc/source/networking/service-function-chaining-guide.rst similarity index 100% rename from doc/source/service-function-chaining-guide.rst rename to doc/source/networking/service-function-chaining-guide.rst diff --git a/doc/source/vlan-aware-vms-guide.rst b/doc/source/networking/vlan-aware-vms-guide.rst similarity index 100% rename from doc/source/vlan-aware-vms-guide.rst rename to doc/source/networking/vlan-aware-vms-guide.rst diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3d..00000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 00000000..0c408000 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,9 @@ +==================== +Tricircle User Guide +==================== + +.. toctree:: + :maxdepth: 3 + + readme + usage diff --git a/doc/source/user/readme.rst b/doc/source/user/readme.rst new file mode 100644 index 00000000..16aa8cde --- /dev/null +++ b/doc/source/user/readme.rst @@ -0,0 +1,2 @@ +.. include:: ../../../README.rst + :start-line: 10 diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst similarity index 81% rename from doc/source/usage.rst rename to doc/source/user/usage.rst index 7c407cff..36df369f 100644 --- a/doc/source/usage.rst +++ b/doc/source/user/usage.rst @@ -1,6 +1,6 @@ -====== +===== Usage -====== +===== To use tricircle in a project:: diff --git a/index.rst b/index.rst new file mode 100644 index 00000000..63038c86 --- /dev/null +++ b/index.rst @@ -0,0 +1,44 @@ +.. tricircle documentation master file, created by + sphinx-quickstart on Wed Dec 2 17:00:36 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +===================================== +Welcome to Tricircle's documentation! +===================================== + +User Documentation +================== +.. toctree:: + :maxdepth: 3 + + user/index + +Contributor Guide +================= +.. toctree:: + :maxdepth: 1 + + contributor/index + +Admin Guide +=========== +.. toctree:: + :maxdepth: 3 + + admin/index + +Installation Guide +================== +.. toctree:: + :maxdepth: 3 + + install/index + +Configuration Guide +=================== +.. toctree:: + :maxdepth: 3 + + configuration/index +