C-Docs: Fixes and improvments

Change-Id: I167720869e15236fde76a91559c17bf94f0ed68d
Signed-off-by: Tibor Frank <tifrank@cisco.com>

diff --git a/docs/content/_index.md b/docs/content/_index.md
index dead278..42f0418 100644 (file)
--- a/docs/content/_index.md
+++ b/docs/content/_index.md
@@ -6,34 +6,43 @@ type: "docs"
 # Documentation Structure
 
 1. OVERVIEW: General introduction to CSIT Performance Dashboard and CSIT itself.
-   - **C-Dash**: The design and the structure of C-Dash dashboard.
-   - **CSIT**: The design of the [FD.io](https://fd.io/) CSIT system, and the
-     description of the test scenarios, test naming and test tags.
+   - **[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**: Terminology, per-thread resources, multi-core speedup, VPP
-     forwarding modes and DUT state considerations.
-   - **Measurement**: Data plane throughput, packet latency and the telemetry.
-   - **Test**: Methodology of all tests used in CSIT.
-   - **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**: A methodology similar to trending analysis is used
-     for comparing performance before a DUT code change is merged.
+   - **[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**: The release notes of the current CSIT release.
-   - **Previous**: Archived release notes for the past releases.
+   - **[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**: Physical testbeds location.
-   - **FD.io DC Testbed Specifications**: Specification of the physical
-     testbed infrastructure.
-   - **FD.io DC Testbed Configuration**: Configuration of the physical
-     testbed infrastructure.
-   - **FD.io CSIT Testbed Versioning**: CSIT test environment versioning to
-     track modifications of the test environment.
-   - **FD.io 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.
-   - **VPP Startup Settings**: List of common settings applied to all tests and
-     test dependent settings.
-   - **TRex Traffic Generator**: Usage of TRex traffic generator and its traffic
-     modes, profiles etc.
+   - **[FD.io DC Vexxhost Inventory](infrastructure/fdio_dc_vexxhost_inventory)**:
+     Physical testbeds location.
+   - **[FD.io DC Testbed Specifications](infrastructure/fdio_dc_testbed_specifications)**:
+     Specification of the physical testbed infrastructure.
+   - **[FD.io DC Testbed Configuration](infrastructure/testbed_configuration)**:
+     Configuration of the physical testbed infrastructure.
+   - **[FD.io CSIT Testbed Versioning](infrastructure/fdio_csit_testbed_versioning)**:
+     CSIT test environment versioning to track modifications of the test
+     environment.
+   - **[FD.io CSIT Logical Topologies](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.
+   - **[VPP Startup Settings](infrastructure/vpp_startup_settings)**: List of
+     common settings applied to all tests and test dependent settings.

diff --git a/docs/content/infrastructure/fdio_csit_testbed_versioning.md b/docs/content/infrastructure/fdio_csit_testbed_versioning.md
index 2607dc0..7aba1cd 100644 (file)
--- a/docs/content/infrastructure/fdio_csit_testbed_versioning.md
+++ b/docs/content/infrastructure/fdio_csit_testbed_versioning.md
@@ -120,11 +120,11 @@ Following is the list of CSIT versions to date:
   - Ubuntu upgrade from 20.04.2 LTS to 22.04.1 LTS.
   - TRex version upgrade: increase from 2.97 to 3.00.
 - Ver. 12 associated with CSIT rls2306 branch (
-  [HW](https://git.fd.io/csit/tree/docs/lab?h=rls2306),
+  [HW](https://git.fd.io/csit/tree/docs/content/infrastructure/testbed_configuration?h=rls2306),
   [CSIT](https://git.fd.io/csit/tree/?h=rls2306)
   ).
   - Intel NIC 700/800 series firmware upgrade based on DPDK compatibility
     matrix.
-  - Mellanox 556A/MCX713106AS-VEAT series firmware upgrade based on DPDK compatibility
-    matrix.
-  - TRex version upgrade: increase from 3.00 to 3.03.
\ No newline at end of file
+  - Mellanox 556A/MCX713106AS-VEAT series firmware upgrade based on DPDK
+    compatibility matrix.
+  - TRex version upgrade: increase from 3.00 to 3.03.

diff --git a/docs/content/infrastructure/testbed_configuration/_index.md b/docs/content/infrastructure/testbed_configuration/_index.md
index 79d0250..25ec487 100644 (file)
--- a/docs/content/infrastructure/testbed_configuration/_index.md
+++ b/docs/content/infrastructure/testbed_configuration/_index.md
@@ -3,4 +3,14 @@ bookCollapseSection: true
 bookFlatSection: false
 title: "FD.io DC Testbed Configuration"
 weight: 3
----
\ No newline at end of file
+---
+
+# 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)

diff --git a/docs/content/methodology/measurements/_index.md b/docs/content/methodology/measurements/_index.md
index 9e92329..4e4a7aa 100644 (file)
--- a/docs/content/methodology/measurements/_index.md
+++ b/docs/content/methodology/measurements/_index.md
@@ -4,3 +4,9 @@ bookFlatSection: false
 title: "Measurements"
 weight: 2
 ---
+
+# Measurement
+
+- [Data Plane Throughput](data_plane_throughput)
+- [Packet Latency](packet_latency)
+- [Telemetry](telemetry)

diff --git a/docs/content/methodology/measurements/data_plane_throughput/_index.md b/docs/content/methodology/measurements/data_plane_throughput/_index.md
index 8fc7f66..89d5d6b 100644 (file)
--- a/docs/content/methodology/measurements/data_plane_throughput/_index.md
+++ b/docs/content/methodology/measurements/data_plane_throughput/_index.md
@@ -3,4 +3,11 @@ bookCollapseSection: true
 bookFlatSection: false
 title: "Data Plane Throughput"
 weight: 1
----
\ No newline at end of file
+---
+
+# Data Plane Throughput
+
+- [Overview](data_plane_throughput)
+- [MLR Search](mlr_search)
+- [PLR Search](plr_search)
+- [MRR](mrr)

diff --git a/docs/content/methodology/overview/_index.md b/docs/content/methodology/overview/_index.md
index 10f3620..d336361 100644 (file)
--- a/docs/content/methodology/overview/_index.md
+++ b/docs/content/methodology/overview/_index.md
@@ -4,3 +4,12 @@ bookFlatSection: false
 title: "Overview"
 weight: 1
 ---
+
+# 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)

diff --git a/docs/content/infrastructure/trex_traffic_generator.md b/docs/content/methodology/overview/trex_traffic_generator.md
similarity index 98%
rename from docs/content/infrastructure/trex_traffic_generator.md
rename to docs/content/methodology/overview/trex_traffic_generator.md
index 3497447..8771bf9 100644 (file)
--- a/docs/content/infrastructure/trex_traffic_generator.md
+++ b/docs/content/methodology/overview/trex_traffic_generator.md
@@ -1,6 +1,6 @@
 ---
 title: "TRex Traffic Generator"
-weight: 7
+weight: 6
 ---
 
 # TRex Traffic Generator
@@ -9,7 +9,7 @@ weight: 7
 
 [TRex traffic generator](https://trex-tgn.cisco.com) is used for majority of
 CSIT performance tests. TRex is used in multiple types of performance tests,
-see [Data Plane Throughtput]({{< ref "../methodology/measurements/data_plane_throughput/data_plane_throughput/#Data Plane Throughtput" >}})
+see [Data Plane Throughtput]({{< ref "../measurements/data_plane_throughput/data_plane_throughput/#Data Plane Throughtput" >}})
 for more details.
 
 ## Traffic modes

diff --git a/docs/content/methodology/test/_index.md b/docs/content/methodology/test/_index.md
index 857cc7b..fc18b46 100644 (file)
--- a/docs/content/methodology/test/_index.md
+++ b/docs/content/methodology/test/_index.md
@@ -1,6 +1,19 @@
 ---
 bookCollapseSection: true
 bookFlatSection: false
-title: "Test"
+title: "Tests"
 weight: 3
 ---
+
+# 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)

diff --git a/docs/content/methodology/test/hoststack/_index.md b/docs/content/methodology/test/hoststack/_index.md
index 2ae872c..61e290c 100644 (file)
--- a/docs/content/methodology/test/hoststack/_index.md
+++ b/docs/content/methodology/test/hoststack/_index.md
@@ -4,3 +4,10 @@ bookFlatSection: false
 title: "Hoststack"
 weight: 6
 ---
+
+# 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)

diff --git a/docs/content/methodology/trending/_index.md b/docs/content/methodology/trending/_index.md
index 4289e7f..0876590 100644 (file)
--- a/docs/content/methodology/trending/_index.md
+++ b/docs/content/methodology/trending/_index.md
@@ -10,3 +10,6 @@ weight: 4
 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).
+
+- [Analysis](analysis)
+- [Presentation](presentation)

diff --git a/docs/content/overview/c_dash/_index.md b/docs/content/overview/c_dash/_index.md
index 97b3510..43c5d27 100644 (file)
--- a/docs/content/overview/c_dash/_index.md
+++ b/docs/content/overview/c_dash/_index.md
@@ -1,6 +1,11 @@
 ---
 bookCollapseSection: true
 bookFlatSection: false
-title: "C-Dash"
+title: "CSIT-Dash"
 weight: 1
 ---
+
+# CSIT-Dash
+
+- [Design](design)
+- [Structure](structure)

diff --git a/docs/content/overview/c_dash/releases.md b/docs/content/overview/c_dash/releases.md
deleted file mode 100644 (file)
index 3cf40ca..0000000
--- a/docs/content/overview/c_dash/releases.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-title: "Releases"
-weight: 3
----
-
-# Releases
-
-## C-Dash v1
-
-Initial release.

diff --git a/docs/content/overview/csit/_index.md b/docs/content/overview/csit/_index.md
index 959348d..b233dd5 100644 (file)
--- a/docs/content/overview/csit/_index.md
+++ b/docs/content/overview/csit/_index.md
@@ -4,3 +4,11 @@ bookFlatSection: false
 title: "CSIT"
 weight: 2
 ---
+
+# CSIT
+
+- [Design](design)
+- [Test Scenarios](test_scenarios)
+- [Test Naming](test_naming)
+- [Test Tags](test_tags)
+- [Suite Generation](suite_generation)

diff --git a/docs/content/overview/csit/design.md b/docs/content/overview/csit/design.md
index 7bb0816..f43d91a 100644 (file)
--- a/docs/content/overview/csit/design.md
+++ b/docs/content/overview/csit/design.md
@@ -69,7 +69,7 @@ A brief bottom-up description is provided here:
      - DPDK-L3Fwd;
      - TRex
    - Tools:
-     - C-Dash
+     - CSIT-Dash
      - Testbed environment setup ansible playbooks;
      - Operational debugging scripts;
 

diff --git a/docs/content/release_notes/csit_rls2306/_index.md b/docs/content/release_notes/csit_rls2306/_index.md
index 27abbb7..fe348c9 100644 (file)
--- a/docs/content/release_notes/csit_rls2306/_index.md
+++ b/docs/content/release_notes/csit_rls2306/_index.md
@@ -4,3 +4,10 @@ bookFlatSection: false
 title: "CSIT rls2306"
 weight: 1
 ---
+
+# CSIT rls2306
+
+- [VPP Performance](vpp_performance)
+- [DPDK Performance](dpdk_performance)
+- [TRex Performance](trex_performance)
+- [VPP Device](vpp_device)

diff --git a/docs/content/release_notes/previous/_index.md b/docs/content/release_notes/previous/_index.md
index 40716f8..5e270d7 100644 (file)
--- a/docs/content/release_notes/previous/_index.md
+++ b/docs/content/release_notes/previous/_index.md
@@ -4,3 +4,7 @@ bookFlatSection: false
 title: "Previous"
 weight: 2
 ---
+
+# Previous Releases
+
+- [CSIT rls2302](csit_rls2302)

diff --git a/docs/content/release_notes/previous/csit_rls2302/_index.md b/docs/content/release_notes/previous/csit_rls2302/_index.md
index aac03a9..d859001 100644 (file)
--- a/docs/content/release_notes/previous/csit_rls2302/_index.md
+++ b/docs/content/release_notes/previous/csit_rls2302/_index.md
@@ -4,3 +4,10 @@ bookFlatSection: false
 title: "CSIT rls2302"
 weight: 1
 ---
+
+# CSIT rls2302
+
+- [VPP Performance](vpp_performance)
+- [DPDK Performance](dpdk_performance)
+- [TRex Performance](trex_performance)
+- [VPP Device](vpp_device)