C-Docs: Fix internal links 94/39094/2
authorTibor Frank <tifrank@cisco.com>
Wed, 21 Jun 2023 08:38:22 +0000 (08:38 +0000)
committerTibor Frank <tifrank@cisco.com>
Wed, 21 Jun 2023 08:39:24 +0000 (08:39 +0000)
Change-Id: I2843788e91d16ce2b7a2283817bf3f44421aca67
Signed-off-by: Tibor Frank <tifrank@cisco.com>
13 files changed:
docs/content/_index.md
docs/content/infrastructure/testbed_configuration/_index.md
docs/content/methodology/measurements/_index.md
docs/content/methodology/measurements/data_plane_throughput/_index.md
docs/content/methodology/overview/_index.md
docs/content/methodology/test/_index.md
docs/content/methodology/test/hoststack/_index.md
docs/content/methodology/trending/_index.md
docs/content/overview/c_dash/_index.md
docs/content/overview/csit/_index.md
docs/content/release_notes/csit_rls2306/_index.md
docs/content/release_notes/previous/_index.md
docs/content/release_notes/previous/csit_rls2302/_index.md

index 42f0418..9c09aa8 100644 (file)
@@ -6,43 +6,44 @@ type: "docs"
 # Documentation Structure
 
 1. OVERVIEW: General introduction to CSIT Performance Dashboard and CSIT itself.
 # Documentation Structure
 
 1. OVERVIEW: General introduction to CSIT Performance Dashboard and CSIT itself.
-   - **[CSIT-Dash](overview/c_dash)**: The design and the structure of
-     CSIT-Dash dashboard.
-   - **[CSIT](overview/csit)**: The design of the [FD.io](https://fd.io/)
-     CSIT system, and the description of the test scenarios, test naming and
-     test tags.
-2. METHODOLOGY
-   - **[Overview](methodology/overview)**: Terminology, per-thread
-     resources, multi-core speedup, VPP forwarding modes and DUT state
-     considerations.
-   - **[Measurement](methodology/measurements)**: Data plane throughput, packet
-     latency and the telemetry.
-   - **[Test](methodology/test)**: Methodology of all tests used in CSIT.
-   - **[Trending](methodology/trending)**: A high-level design of a system for
-     continuous performance measuring, trending and change detection for FD.io
-     VPP SW data plane (and other performance tests run within CSIT
-     sub-project).
-   - **[Per-patch Testing](methodology/per_patch_testing)**: A methodology
-     similar to trending analysis is used for comparing performance before a DUT
-     code change is merged.
-3. RELEASE NOTES: Performance tests executed in physical FD.io testbeds.
-   - **[CSIT rls2306](release_notes/csit_rls2306)**: The release notes of the
-     current CSIT release.
-   - **[Previous](release_notes/previous)**: Archived release notes for the past
-     releases.
-4. INFRASTRUCTURE
-   - **[FD.io DC Vexxhost Inventory](infrastructure/fdio_dc_vexxhost_inventory)**:
+   - **[CSIT-Dash]({{< relref "/overview/c_dash/" >}})**: The design and the
+     structure of CSIT-Dash dashboard.
+   - **[CSIT]({{< relref "/overview/csit/" >}})**: The design of the
+     [FD.io](https://fd.io/) CSIT system, and the description of the test
+     scenarios, test naming and test tags.
+1. METHODOLOGY
+   - **[Overview]({{< relref "/methodology/overview/" >}})**: Terminology,
+     per-thread resources, multi-core speedup, VPP forwarding modes and DUT
+     state considerations.
+   - **[Measurement]({{< relref "/methodology/measurements/" >}})**: Data plane
+     throughput, packet latency and the telemetry.
+   - **[Test]({{< relref "/methodology/test/" >}})**: Methodology of all tests
+     used in CSIT.
+   - **[Trending]({{< relref "/methodology/trending/" >}})**: A high-level
+     design of a system for continuous performance measuring, trending and
+     change detection for FD.io VPP SW data plane (and other performance tests
+     run within CSIT sub-project).
+   - **[Per-patch Testing]({{< relref "/methodology/per_patch_testing" >}})**:
+     A methodology similar to trending analysis is used for comparing
+     performance before a DUT code change is merged.
+2. RELEASE NOTES: Performance tests executed in physical FD.io testbeds.
+   - **[CSIT rls2306]({{< relref "/release_notes/csit_rls2306/" >}})**: The
+     release notes of the current CSIT release.
+   - **[Previous]({{< relref "/release_notes/previous/" >}})**: Archived release
+     notes for the past releases.
+3. INFRASTRUCTURE
+   - **[FD.io DC Vexxhost Inventory]({{< relref "/infrastructure/fdio_dc_vexxhost_inventory" >}})**:
      Physical testbeds location.
      Physical testbeds location.
-   - **[FD.io DC Testbed Specifications](infrastructure/fdio_dc_testbed_specifications)**:
+   - **[FD.io DC Testbed Specifications]({{< relref "/infrastructure/fdio_dc_testbed_specifications" >}})**:
      Specification of the physical testbed infrastructure.
      Specification of the physical testbed infrastructure.
-   - **[FD.io DC Testbed Configuration](infrastructure/testbed_configuration)**:
+   - **[FD.io DC Testbed Configuration]({{< relref "/infrastructure/testbed_configuration/" >}})**:
      Configuration of the physical testbed infrastructure.
      Configuration of the physical testbed infrastructure.
-   - **[FD.io CSIT Testbed Versioning](infrastructure/fdio_csit_testbed_versioning)**:
+   - **[FD.io CSIT Testbed Versioning]({{< relref "/infrastructure/fdio_csit_testbed_versioning" >}})**:
      CSIT test environment versioning to track modifications of the test
      environment.
      CSIT test environment versioning to track modifications of the test
      environment.
-   - **[FD.io CSIT Logical Topologies](infrastructure/fdio_csit_logical_topologies)**:
+   - **[FD.io CSIT Logical Topologies]({{< relref "/infrastructure/fdio_csit_logical_topologies" >}})**:
      CSIT performance tests are executed on physical testbeds. Based on the
      packet path thru server SUTs, three distinct logical topology types are
      used for VPP DUT data plane testing.
      CSIT performance tests are executed on physical testbeds. Based on the
      packet path thru server SUTs, three distinct logical topology types are
      used for VPP DUT data plane testing.
-   - **[VPP Startup Settings](infrastructure/vpp_startup_settings)**: List of
-     common settings applied to all tests and test dependent settings.
+   - **[VPP Startup Settings]({{< relref "/infrastructure/vpp_startup_settings" >}})**:
+     List of common settings applied to all tests and test dependent settings.
index 25ec487..50159f0 100644 (file)
@@ -7,10 +7,10 @@ weight: 3
 
 # FD.io DC Testbed Configuration
 
 
 # FD.io DC Testbed Configuration
 
-- [GigaByte ThunderX2](gigabyte_tx2_hw_bios_cfg)
-- [Huawei Taishan](huawei_tsh_hw_bios_cfg)
-- [MegaRac Altra](ami_alt_hw_bios_cfg)
-- [SuperMicro Cascadelake](sm_clx_hw_bios_cfg)
-- [SuperMicro EPYC Zen2](sm_zn2_hw_bios_cfg)
-- [SuperMicro Icelake](sm_icx_hw_bios_cfg)
-- [SuperMicro SapphireRapids](sm_spr_hw_bios_cfg)
+- [GigaByte ThunderX2]({{< relref "/infrastructure/testbed_configuration/gigabyte_tx2_hw_bios_cfg" >}})
+- [Huawei Taishan]({{< relref "/infrastructure/testbed_configuration/huawei_tsh_hw_bios_cfg" >}})
+- [MegaRac Altra]({{< relref "/infrastructure/testbed_configuration/ami_alt_hw_bios_cfg" >}})
+- [SuperMicro Cascadelake]({{< relref "/infrastructure/testbed_configuration/sm_clx_hw_bios_cfg" >}})
+- [SuperMicro EPYC Zen2]({{< relref "/infrastructure/testbed_configuration/sm_zn2_hw_bios_cfg" >}})
+- [SuperMicro Icelake]({{< relref "/infrastructure/testbed_configuration/sm_icx_hw_bios_cfg" >}})
+- [SuperMicro SapphireRapids]({{< relref "/infrastructure/testbed_configuration/sm_spr_hw_bios_cfg" >}})
index 4e4a7aa..21176fe 100644 (file)
@@ -7,6 +7,6 @@ weight: 2
 
 # Measurement
 
 
 # Measurement
 
-- [Data Plane Throughput](data_plane_throughput)
-- [Packet Latency](packet_latency)
-- [Telemetry](telemetry)
+- [Data Plane Throughput]({{< relref "/methodology/measurements/data_plane_throughput" >}})
+- [Packet Latency]({{< relref "/methodology/measurements/packet_latency" >}})
+- [Telemetry]({{< relref "/methodology/measurements/telemetry" >}})
index 89d5d6b..30b55f1 100644 (file)
@@ -7,7 +7,7 @@ weight: 1
 
 # Data Plane Throughput
 
 
 # Data Plane Throughput
 
-- [Overview](data_plane_throughput)
-- [MLR Search](mlr_search)
-- [PLR Search](plr_search)
-- [MRR](mrr)
+- [Overview]({{< relref "/methodology/measurements/data_plane_throughput/data_plane_throughput" >}})
+- [MLR Search]({{< relref "/methodology/measurements/data_plane_throughput/mlr_search" >}})
+- [PLR Search]({{< relref "/methodology/measurements/data_plane_throughput/plr_search" >}})
+- [MRR]({{< relref "/methodology/measurements/data_plane_throughput/mrr" >}})
\ No newline at end of file
index d336361..d7efd15 100644 (file)
@@ -7,9 +7,9 @@ weight: 1
 
 # Methodology
 
 
 # Methodology
 
-- [Terminology](terminology)
-- [Per Thread Resources](per_thread_resources)
-- [Multi-Core Speedup](multi_core_speedup)
-- [VPP Forwarding Modes](vpp_forwarding_modes)
-- [DUT State Considerations](dut_state_considerations)
-- [TRex Traffic Generator](trex_traffic_generator)
+- [Terminology]({{< relref "/methodology/overview/terminology" >}})
+- [Per Thread Resources]({{< relref "/methodology/overview/per_thread_resources" >}})
+- [Multi-Core Speedup]({{< relref "/methodology/overview/multi_core_speedup" >}})
+- [VPP Forwarding Modes]({{< relref "/methodology/overview/vpp_forwarding_modes" >}})
+- [DUT State Considerations]({{< relref "/methodology/overview/dut_state_considerations" >}})
+- [TRex Traffic Generator]({{< relref "/methodology/overview/trex_traffic_generator" >}})
index fc18b46..e9864ac 100644 (file)
@@ -7,13 +7,13 @@ weight: 3
 
 # Tests
 
 
 # Tests
 
-- [Network Address Translation](network_address_translation)
-- [Packet Flow Ordering](packet_flow_ordering)
-- [Tunnel Encapsulations](tunnel_encapsulations)
-- [Internet Protocol Security](internet_protocol_security)
-- [Access Control Lists](access_control_lists)
-- [Hoststack](hoststack)
-- [Generic Segmentation Offload](generic_segmentation_offload)
-- [Reconfiguration](reconfiguration)
-- [VPP Device](vpp_device)
-- [Reassembly](reassembly)
+- [Network Address Translation]({{< relref "/methodology/test/network_address_translation" >}})
+- [Packet Flow Ordering]({{< relref "/methodology/test/packet_flow_ordering" >}})
+- [Tunnel Encapsulations]({{< relref "/methodology/test/tunnel_encapsulations" >}})
+- [Internet Protocol Security]({{< relref "/methodology/test/internet_protocol_security" >}})
+- [Access Control Lists]({{< relref "/methodology/test/access_control_lists" >}})
+- [Hoststack]({{< relref "/methodology/test/hoststack/" >}})
+- [Generic Segmentation Offload]({{< relref "/methodology/test/generic_segmentation_offload" >}})
+- [Reconfiguration]({{< relref "/methodology/test/reconfiguration" >}})
+- [VPP Device]({{< relref "/methodology/test/vpp_device" >}})
+- [Reassembly]({{< relref "/methodology/test/reassembly" >}})
index 61e290c..6c0cb29 100644 (file)
@@ -7,7 +7,7 @@ weight: 6
 
 # Hoststack
 
 
 # Hoststack
 
-- [QUIC/UDP/IP with vpp_echo](quicudpip_with_vppecho)
-- [TCP/IP with iperf3](tcpip_with_iperf3)
-- [UDP/IP with iperf3](udpip_with_iperf3)
-- [VSAP ab with nginx](vsap_ab_with_nginx)
+- [QUIC/UDP/IP with vpp_echo]({{< relref "/methodology/test/hoststack/quicudpip_with_vppecho" >}})
+- [TCP/IP with iperf3]({{< relref "/methodology/test/hoststack/tcpip_with_iperf3" >}})
+- [UDP/IP with iperf3]({{< relref "/methodology/test/hoststack/udpip_with_iperf3" >}})
+- [VSAP ab with nginx]({{< relref "/methodology/test/hoststack/vsap_ab_with_nginx" >}})
index 0876590..d1a57d7 100644 (file)
@@ -11,5 +11,5 @@ This document describes a high-level design of a system for continuous
 performance measuring, trending and change detection for FD.io VPP SW
 data plane (and other performance tests run within CSIT sub-project).
 
 performance measuring, trending and change detection for FD.io VPP SW
 data plane (and other performance tests run within CSIT sub-project).
 
-- [Analysis](analysis)
-- [Presentation](presentation)
+- [Analysis]({{< relref "/methodology/trending/analysis" >}})
+- [Presentation]({{< relref "/methodology/trending/presentation" >}})
index 43c5d27..8a473a3 100644 (file)
@@ -7,5 +7,5 @@ weight: 1
 
 # CSIT-Dash
 
 
 # CSIT-Dash
 
-- [Design](design)
-- [Structure](structure)
+- [Design]({{< relref "/overview/c_dash/design" >}})
+- [Structure]({{< relref "/overview/c_dash/structure" >}})
index b233dd5..29f0164 100644 (file)
@@ -7,8 +7,8 @@ weight: 2
 
 # CSIT
 
 
 # CSIT
 
-- [Design](design)
-- [Test Scenarios](test_scenarios)
-- [Test Naming](test_naming)
-- [Test Tags](test_tags)
-- [Suite Generation](suite_generation)
+- [Design]({{< relref "/overview/csit/design" >}})
+- [Test Scenarios]({{< relref "/overview/csit/test_scenarios" >}})
+- [Test Naming]({{< relref "/overview/csit/test_naming" >}})
+- [Test Tags]({{< relref "/overview/csit/test_tags" >}})
+- [Suite Generation]({{< relref "/overview/csit/suite_generation" >}})
index fe348c9..c2a1cbb 100644 (file)
@@ -7,7 +7,7 @@ weight: 1
 
 # CSIT rls2306
 
 
 # CSIT rls2306
 
-- [VPP Performance](vpp_performance)
-- [DPDK Performance](dpdk_performance)
-- [TRex Performance](trex_performance)
-- [VPP Device](vpp_device)
+- [VPP Performance]({{< relref "/release_notes/csit_rls2306/vpp_performance" >}})
+- [DPDK Performance]({{< relref "/release_notes/csit_rls2306/dpdk_performance" >}})
+- [TRex Performance]({{< relref "/release_notes/csit_rls2306/trex_performance" >}})
+- [VPP Device]({{< relref "/release_notes/csit_rls2306/vpp_device" >}})
index 5e270d7..601c7aa 100644 (file)
@@ -7,4 +7,4 @@ weight: 2
 
 # Previous Releases
 
 
 # Previous Releases
 
-- [CSIT rls2302](csit_rls2302)
+- [CSIT rls2302]({{< relref "/release_notes/previous/csit_rls2302" >}})
index d859001..9f193c5 100644 (file)
@@ -7,7 +7,7 @@ weight: 1
 
 # CSIT rls2302
 
 
 # CSIT rls2302
 
-- [VPP Performance](vpp_performance)
-- [DPDK Performance](dpdk_performance)
-- [TRex Performance](trex_performance)
-- [VPP Device](vpp_device)
+- [VPP Performance]({{< relref "/release_notes/previous/csit_rls2302/vpp_performance" >}})
+- [DPDK Performance]({{< relref "/release_notes/previous/csit_rls2302/dpdk_performance" >}})
+- [TRex Performance]({{< relref "/release_notes/previous/csit_rls2302/trex_performance" >}})
+- [VPP Device]({{< relref "/release_notes/previous/csit_rls2302/vpp_device" >}})