From bd80bcfb59a948d47af4d970f2832e8079f5f0f0 Mon Sep 17 00:00:00 2001 From: yuyang Date: Wed, 8 Mar 2017 11:17:40 +0800 Subject: [PATCH] Apply docs strucutre to Danube agreement JIRA: BOTTLENECK-137 According to the agreement in Testperf meeting. Change the structure of docs. Change-Id: Ie370de1e7a24c918aedc8a2cdb2cca0508ef4257 Signed-off-by: yuyang --- docs/platform_overview/index.rst | 12 ------------ docs/{release_notes => release}/index.rst | 6 +++--- .../release-notes}/release_notes.rst | 0 .../release-notes}/requirements_notes.rst | 0 .../{testing_guide => testing/developer}/dashboard_guide.rst | 0 docs/{testing_guide => testing/developer}/index.rst | 0 docs/{testing_guide => testing/developer}/overview.rst | 0 docs/{testing_guide => testing/developer}/posca_guide.rst | 0 docs/{testing_guide => testing/developer}/rubbos_guide.rst | 0 docs/{testing_guide => testing/developer}/vstf_guide.rst | 0 .../introduction.rst => testing/index.rst} | 9 +++++++++ docs/{user_guide => testing/user}/index.rst | 0 .../{user_guide => testing/user}/posca/posca_stress_ping.rst | 0 .../user}/posca/posca_stress_traffic.rst | 0 docs/{user_guide => testing/user}/rubbos/rubbos_basic.rst | 0 .../user}/rubbos/rubbos_heavy_tc1101.rst | 0 docs/{user_guide => testing/user}/rubbos/rubbos_tc1101.rst | 0 docs/{user_guide => testing/user}/rubbos/rubbos_tc1201.rst | 0 docs/{user_guide => testing/user}/rubbos/rubbos_tc1301.rst | 0 docs/{user_guide => testing/user}/rubbos/rubbos_tc1401.rst | 0 docs/{user_guide => testing/user}/vstf/vstf_Ti1.rst | 0 docs/{user_guide => testing/user}/vstf/vstf_Ti2.rst | 0 docs/{user_guide => testing/user}/vstf/vstf_Ti3.rst | 0 docs/{user_guide => testing/user}/vstf/vstf_Tn1.rst | 0 docs/{user_guide => testing/user}/vstf/vstf_Tn2.rst | 0 docs/{user_guide => testing/user}/vstf/vstf_Tu1.rst | 0 docs/{user_guide => testing/user}/vstf/vstf_Tu2.rst | 0 docs/{user_guide => testing/user}/vstf/vstf_Tu3.rst | 0 28 files changed, 12 insertions(+), 15 deletions(-) delete mode 100644 docs/platform_overview/index.rst rename docs/{release_notes => release}/index.rst (80%) rename docs/{release_notes => release/release-notes}/release_notes.rst (100%) rename docs/{release_notes => release/release-notes}/requirements_notes.rst (100%) rename docs/{testing_guide => testing/developer}/dashboard_guide.rst (100%) rename docs/{testing_guide => testing/developer}/index.rst (100%) rename docs/{testing_guide => testing/developer}/overview.rst (100%) rename docs/{testing_guide => testing/developer}/posca_guide.rst (100%) rename docs/{testing_guide => testing/developer}/rubbos_guide.rst (100%) rename docs/{testing_guide => testing/developer}/vstf_guide.rst (100%) rename docs/{platform_overview/introduction.rst => testing/index.rst} (95%) rename docs/{user_guide => testing/user}/index.rst (100%) rename docs/{user_guide => testing/user}/posca/posca_stress_ping.rst (100%) rename docs/{user_guide => testing/user}/posca/posca_stress_traffic.rst (100%) rename docs/{user_guide => testing/user}/rubbos/rubbos_basic.rst (100%) rename docs/{user_guide => testing/user}/rubbos/rubbos_heavy_tc1101.rst (100%) rename docs/{user_guide => testing/user}/rubbos/rubbos_tc1101.rst (100%) rename docs/{user_guide => testing/user}/rubbos/rubbos_tc1201.rst (100%) rename docs/{user_guide => testing/user}/rubbos/rubbos_tc1301.rst (100%) rename docs/{user_guide => testing/user}/rubbos/rubbos_tc1401.rst (100%) rename docs/{user_guide => testing/user}/vstf/vstf_Ti1.rst (100%) rename docs/{user_guide => testing/user}/vstf/vstf_Ti2.rst (100%) rename docs/{user_guide => testing/user}/vstf/vstf_Ti3.rst (100%) rename docs/{user_guide => testing/user}/vstf/vstf_Tn1.rst (100%) rename docs/{user_guide => testing/user}/vstf/vstf_Tn2.rst (100%) rename docs/{user_guide => testing/user}/vstf/vstf_Tu1.rst (100%) rename docs/{user_guide => testing/user}/vstf/vstf_Tu2.rst (100%) rename docs/{user_guide => testing/user}/vstf/vstf_Tu3.rst (100%) diff --git a/docs/platform_overview/index.rst b/docs/platform_overview/index.rst deleted file mode 100644 index 81271a43..00000000 --- a/docs/platform_overview/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Huawei Technologies Co.,Ltd and others. - -******************************* -Bottlenecks - Platform Overview -******************************* - -.. toctree:: - :maxdepth: 2 - - ./introduction.rst diff --git a/docs/release_notes/index.rst b/docs/release/index.rst similarity index 80% rename from docs/release_notes/index.rst rename to docs/release/index.rst index 622671cd..17e78444 100644 --- a/docs/release_notes/index.rst +++ b/docs/release/index.rst @@ -1,3 +1,4 @@ +.. _bottlenecks-releasenotes: .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. (c) Huawei Technologies Co.,Ltd and others. @@ -7,7 +8,6 @@ Bottlenecks - Release Notes *************************** .. toctree:: - :maxdepth: 2 + :glob: - ./release_notes.rst - ./requirements_notes.rst + release-notes/* diff --git a/docs/release_notes/release_notes.rst b/docs/release/release-notes/release_notes.rst similarity index 100% rename from docs/release_notes/release_notes.rst rename to docs/release/release-notes/release_notes.rst diff --git a/docs/release_notes/requirements_notes.rst b/docs/release/release-notes/requirements_notes.rst similarity index 100% rename from docs/release_notes/requirements_notes.rst rename to docs/release/release-notes/requirements_notes.rst diff --git a/docs/testing_guide/dashboard_guide.rst b/docs/testing/developer/dashboard_guide.rst similarity index 100% rename from docs/testing_guide/dashboard_guide.rst rename to docs/testing/developer/dashboard_guide.rst diff --git a/docs/testing_guide/index.rst b/docs/testing/developer/index.rst similarity index 100% rename from docs/testing_guide/index.rst rename to docs/testing/developer/index.rst diff --git a/docs/testing_guide/overview.rst b/docs/testing/developer/overview.rst similarity index 100% rename from docs/testing_guide/overview.rst rename to docs/testing/developer/overview.rst diff --git a/docs/testing_guide/posca_guide.rst b/docs/testing/developer/posca_guide.rst similarity index 100% rename from docs/testing_guide/posca_guide.rst rename to docs/testing/developer/posca_guide.rst diff --git a/docs/testing_guide/rubbos_guide.rst b/docs/testing/developer/rubbos_guide.rst similarity index 100% rename from docs/testing_guide/rubbos_guide.rst rename to docs/testing/developer/rubbos_guide.rst diff --git a/docs/testing_guide/vstf_guide.rst b/docs/testing/developer/vstf_guide.rst similarity index 100% rename from docs/testing_guide/vstf_guide.rst rename to docs/testing/developer/vstf_guide.rst diff --git a/docs/platform_overview/introduction.rst b/docs/testing/index.rst similarity index 95% rename from docs/platform_overview/introduction.rst rename to docs/testing/index.rst index cb85e61d..70d3983b 100644 --- a/docs/platform_overview/introduction.rst +++ b/docs/testing/index.rst @@ -23,6 +23,13 @@ This project forms a staging framework to find bottlenecks and to do analysis of The *Bottlenecks* framework is deployed in several OPNFV community labs. It is installer, infrastructure and application independent. +.. toctree:: + :glob: + + developer/index.rst + user/index.rst + * + .. _Pharos: https://wiki.opnfv.org/pharos .. seealso:: Pharos_ for information on OPNFV community labs. @@ -35,3 +42,5 @@ Contact Bottlenecks Feedback `Contact us`_ .. _Contact us: opnfv-users@lists.opnfv.org + + diff --git a/docs/user_guide/index.rst b/docs/testing/user/index.rst similarity index 100% rename from docs/user_guide/index.rst rename to docs/testing/user/index.rst diff --git a/docs/user_guide/posca/posca_stress_ping.rst b/docs/testing/user/posca/posca_stress_ping.rst similarity index 100% rename from docs/user_guide/posca/posca_stress_ping.rst rename to docs/testing/user/posca/posca_stress_ping.rst diff --git a/docs/user_guide/posca/posca_stress_traffic.rst b/docs/testing/user/posca/posca_stress_traffic.rst similarity index 100% rename from docs/user_guide/posca/posca_stress_traffic.rst rename to docs/testing/user/posca/posca_stress_traffic.rst diff --git a/docs/user_guide/rubbos/rubbos_basic.rst b/docs/testing/user/rubbos/rubbos_basic.rst similarity index 100% rename from docs/user_guide/rubbos/rubbos_basic.rst rename to docs/testing/user/rubbos/rubbos_basic.rst diff --git a/docs/user_guide/rubbos/rubbos_heavy_tc1101.rst b/docs/testing/user/rubbos/rubbos_heavy_tc1101.rst similarity index 100% rename from docs/user_guide/rubbos/rubbos_heavy_tc1101.rst rename to docs/testing/user/rubbos/rubbos_heavy_tc1101.rst diff --git a/docs/user_guide/rubbos/rubbos_tc1101.rst b/docs/testing/user/rubbos/rubbos_tc1101.rst similarity index 100% rename from docs/user_guide/rubbos/rubbos_tc1101.rst rename to docs/testing/user/rubbos/rubbos_tc1101.rst diff --git a/docs/user_guide/rubbos/rubbos_tc1201.rst b/docs/testing/user/rubbos/rubbos_tc1201.rst similarity index 100% rename from docs/user_guide/rubbos/rubbos_tc1201.rst rename to docs/testing/user/rubbos/rubbos_tc1201.rst diff --git a/docs/user_guide/rubbos/rubbos_tc1301.rst b/docs/testing/user/rubbos/rubbos_tc1301.rst similarity index 100% rename from docs/user_guide/rubbos/rubbos_tc1301.rst rename to docs/testing/user/rubbos/rubbos_tc1301.rst diff --git a/docs/user_guide/rubbos/rubbos_tc1401.rst b/docs/testing/user/rubbos/rubbos_tc1401.rst similarity index 100% rename from docs/user_guide/rubbos/rubbos_tc1401.rst rename to docs/testing/user/rubbos/rubbos_tc1401.rst diff --git a/docs/user_guide/vstf/vstf_Ti1.rst b/docs/testing/user/vstf/vstf_Ti1.rst similarity index 100% rename from docs/user_guide/vstf/vstf_Ti1.rst rename to docs/testing/user/vstf/vstf_Ti1.rst diff --git a/docs/user_guide/vstf/vstf_Ti2.rst b/docs/testing/user/vstf/vstf_Ti2.rst similarity index 100% rename from docs/user_guide/vstf/vstf_Ti2.rst rename to docs/testing/user/vstf/vstf_Ti2.rst diff --git a/docs/user_guide/vstf/vstf_Ti3.rst b/docs/testing/user/vstf/vstf_Ti3.rst similarity index 100% rename from docs/user_guide/vstf/vstf_Ti3.rst rename to docs/testing/user/vstf/vstf_Ti3.rst diff --git a/docs/user_guide/vstf/vstf_Tn1.rst b/docs/testing/user/vstf/vstf_Tn1.rst similarity index 100% rename from docs/user_guide/vstf/vstf_Tn1.rst rename to docs/testing/user/vstf/vstf_Tn1.rst diff --git a/docs/user_guide/vstf/vstf_Tn2.rst b/docs/testing/user/vstf/vstf_Tn2.rst similarity index 100% rename from docs/user_guide/vstf/vstf_Tn2.rst rename to docs/testing/user/vstf/vstf_Tn2.rst diff --git a/docs/user_guide/vstf/vstf_Tu1.rst b/docs/testing/user/vstf/vstf_Tu1.rst similarity index 100% rename from docs/user_guide/vstf/vstf_Tu1.rst rename to docs/testing/user/vstf/vstf_Tu1.rst diff --git a/docs/user_guide/vstf/vstf_Tu2.rst b/docs/testing/user/vstf/vstf_Tu2.rst similarity index 100% rename from docs/user_guide/vstf/vstf_Tu2.rst rename to docs/testing/user/vstf/vstf_Tu2.rst diff --git a/docs/user_guide/vstf/vstf_Tu3.rst b/docs/testing/user/vstf/vstf_Tu3.rst similarity index 100% rename from docs/user_guide/vstf/vstf_Tu3.rst rename to docs/testing/user/vstf/vstf_Tu3.rst -- 2.16.6