From 804e38037d6c2c5e216bc50df617627e18b97983 Mon Sep 17 00:00:00 2001 From: Tibor Frank Date: Mon, 18 Oct 2021 12:58:33 +0200 Subject: [PATCH] Report: Move CSIT Documentation to Introduction Change-Id: I5454251c33d0187be8a392b4800036388d28597a Signed-off-by: Tibor Frank --- docs/report/dpdk_performance_tests/documentation.rst | 5 ----- docs/report/dpdk_performance_tests/index.rst | 1 - docs/report/index.html.template | 4 +--- .../documentation/containers.rst | 0 .../documentation/documentation.rst | 2 +- .../{vpp_performance_tests => introduction}/documentation/index.rst | 0 docs/report/introduction/index.rst | 1 + docs/report/vpp_device_tests/documentation.rst | 6 ------ docs/report/vpp_device_tests/index.rst | 1 - docs/report/vpp_performance_tests/index.rst | 1 - resources/tools/presentation/sphinx_conf/report/conf.py | 4 +--- 11 files changed, 4 insertions(+), 21 deletions(-) delete mode 100644 docs/report/dpdk_performance_tests/documentation.rst rename docs/report/{vpp_performance_tests => introduction}/documentation/containers.rst (100%) rename docs/report/{vpp_performance_tests => introduction}/documentation/documentation.rst (64%) rename docs/report/{vpp_performance_tests => introduction}/documentation/index.rst (100%) delete mode 100644 docs/report/vpp_device_tests/documentation.rst diff --git a/docs/report/dpdk_performance_tests/documentation.rst b/docs/report/dpdk_performance_tests/documentation.rst deleted file mode 100644 index 254569dc66..0000000000 --- a/docs/report/dpdk_performance_tests/documentation.rst +++ /dev/null @@ -1,5 +0,0 @@ -Documentation -============= - -`CSIT DPDK Performance Tests Documentation`_ contains detailed -functional description and input parameters for each test case. diff --git a/docs/report/dpdk_performance_tests/index.rst b/docs/report/dpdk_performance_tests/index.rst index 5880ee25c0..64e1525387 100644 --- a/docs/report/dpdk_performance_tests/index.rst +++ b/docs/report/dpdk_performance_tests/index.rst @@ -10,4 +10,3 @@ DPDK Performance comparisons/index throughput_trending test_environment - documentation diff --git a/docs/report/index.html.template b/docs/report/index.html.template index 76b7b404a1..489f314cac 100644 --- a/docs/report/index.html.template +++ b/docs/report/index.html.template @@ -10,6 +10,7 @@ CSIT-2110 introduction/test_scenarios_overview introduction/physical_testbeds introduction/methodology + introduction/documentation/index .. toctree:: :maxdepth: 2 @@ -28,7 +29,6 @@ CSIT-2110 vpp_performance_tests/comparisons/index vpp_performance_tests/throughput_trending vpp_performance_tests/test_environment - vpp_performance_tests/documentation/index .. toctree:: :maxdepth: 2 @@ -41,7 +41,6 @@ CSIT-2110 dpdk_performance_tests/comparisons/index dpdk_performance_tests/throughput_trending dpdk_performance_tests/test_environment - dpdk_performance_tests/documentation .. toctree:: :maxdepth: 2 @@ -61,7 +60,6 @@ CSIT-2110 vpp_device_tests/overview vpp_device_tests/csit_release_notes vpp_device_tests/test_environment - vpp_device_tests/documentation .. toctree:: :maxdepth: 2 diff --git a/docs/report/vpp_performance_tests/documentation/containers.rst b/docs/report/introduction/documentation/containers.rst similarity index 100% rename from docs/report/vpp_performance_tests/documentation/containers.rst rename to docs/report/introduction/documentation/containers.rst diff --git a/docs/report/vpp_performance_tests/documentation/documentation.rst b/docs/report/introduction/documentation/documentation.rst similarity index 64% rename from docs/report/vpp_performance_tests/documentation/documentation.rst rename to docs/report/introduction/documentation/documentation.rst index 92bde5627f..3635516924 100644 --- a/docs/report/vpp_performance_tests/documentation/documentation.rst +++ b/docs/report/introduction/documentation/documentation.rst @@ -1,5 +1,5 @@ Test Code Documentation ======================= -`CSIT VPP Performance Tests Documentation`_ contains detailed +`CSIT Performance Tests Documentation`_ contains detailed functional description and input parameters for each test case. diff --git a/docs/report/vpp_performance_tests/documentation/index.rst b/docs/report/introduction/documentation/index.rst similarity index 100% rename from docs/report/vpp_performance_tests/documentation/index.rst rename to docs/report/introduction/documentation/index.rst diff --git a/docs/report/introduction/index.rst b/docs/report/introduction/index.rst index 81a7dc3c49..a15a18fd9d 100644 --- a/docs/report/introduction/index.rst +++ b/docs/report/introduction/index.rst @@ -8,3 +8,4 @@ Introduction test_scenarios_overview physical_testbeds methodology + documentation/index diff --git a/docs/report/vpp_device_tests/documentation.rst b/docs/report/vpp_device_tests/documentation.rst deleted file mode 100644 index 6ab6d51287..0000000000 --- a/docs/report/vpp_device_tests/documentation.rst +++ /dev/null @@ -1,6 +0,0 @@ -Documentation -============= - -`CSIT VPP Device Tests Documentation`_ contains detailed -functional description and input parameters for each test case. - diff --git a/docs/report/vpp_device_tests/index.rst b/docs/report/vpp_device_tests/index.rst index 4a6e6c81e6..841ea98359 100644 --- a/docs/report/vpp_device_tests/index.rst +++ b/docs/report/vpp_device_tests/index.rst @@ -6,4 +6,3 @@ VPP Device overview csit_release_notes test_environment - documentation diff --git a/docs/report/vpp_performance_tests/index.rst b/docs/report/vpp_performance_tests/index.rst index bd497cee77..e54549ed32 100644 --- a/docs/report/vpp_performance_tests/index.rst +++ b/docs/report/vpp_performance_tests/index.rst @@ -16,4 +16,3 @@ VPP Performance comparisons/index throughput_trending test_environment - documentation/index diff --git a/resources/tools/presentation/sphinx_conf/report/conf.py b/resources/tools/presentation/sphinx_conf/report/conf.py index 364976028c..799a16eea8 100644 --- a/resources/tools/presentation/sphinx_conf/report/conf.py +++ b/resources/tools/presentation/sphinx_conf/report/conf.py @@ -74,9 +74,7 @@ rst_epilog = u""" .. _pdf version of this report: https://s3-docs.fd.io/csit/{release}/report/_static/archive/csit_{release}.{report_week}.pdf .. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h={release} .. _TRex driver: https://git.fd.io/csit/tree/GPL/tools/trex/trex_stl_profile.py?h={release} -.. _CSIT DPDK Performance Tests Documentation: https://s3-docs.fd.io/csit/{release}/doc/tests.dpdk.perf.html -.. _CSIT VPP Performance Tests Documentation: https://s3-docs.fd.io/csit/{release}/doc/tests.vpp.perf.html -.. _CSIT VPP Device Tests Documentation: https://s3-docs.fd.io/csit/{release}/doc/tests.vpp.device.html +.. _CSIT Performance Tests Documentation: https://s3-docs.fd.io/csit/{release}/doc/index.html .. _VPP test framework documentation: https://docs.fd.io/vpp/{vpprelease}/vpp_make_test/html/ .. _FD.io CSIT testbeds - Xeon Skylake, Arm, Atom: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_skx_hw_bios_cfg.md?h={release} .. _FD.io CSIT testbeds - Xeon Cascade Lake: https://git.fd.io/csit/tree/docs/lab/testbeds_sm_clx_hw_bios_cfg.md?h={release} -- 2.16.6