From 192e1ac1f274d8eed3d33cdbc15fa995a74247c7 Mon Sep 17 00:00:00 2001 From: Tibor Frank Date: Thu, 13 Jul 2023 05:51:20 +0000 Subject: [PATCH] C-Docs: Optimize url links Change-Id: I95ae31a84a12c5f5762197e257f30667debc6c0c Signed-off-by: Tibor Frank --- docs/content/_index.md | 4 +-- docs/content/overview/csit/_index.md | 41 +++++++++++++++++++++- .../{csit_rls2306 => current}/_index.md | 8 ++--- .../{csit_rls2306 => current}/dpdk_performance.md | 0 .../{csit_rls2306 => current}/trex_performance.md | 0 .../{csit_rls2306 => current}/vpp_device.md | 0 .../{csit_rls2306 => current}/vpp_performance.md | 0 docs/content/release_notes/previous/_index.md | 2 +- .../release_notes/previous/csit_rls2302/_index.md | 8 ++--- 9 files changed, 51 insertions(+), 12 deletions(-) rename docs/content/release_notes/{csit_rls2306 => current}/_index.md (92%) rename docs/content/release_notes/{csit_rls2306 => current}/dpdk_performance.md (100%) rename docs/content/release_notes/{csit_rls2306 => current}/trex_performance.md (100%) rename docs/content/release_notes/{csit_rls2306 => current}/vpp_device.md (100%) rename docs/content/release_notes/{csit_rls2306 => current}/vpp_performance.md (100%) diff --git a/docs/content/_index.md b/docs/content/_index.md index 6d96529995..8f257b724c 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -8,7 +8,7 @@ type: "docs" 1. OVERVIEW: General introduction to CSIT Performance Dashboard and CSIT itself. - **[CSIT-Dash]({{< relref "/overview/c_dash/design" >}})**: The design and the structure of CSIT-Dash dashboard. - - **[CSIT]({{< relref "/overview/csit/design" >}})**: The design of the + - **[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. 2. METHODOLOGY @@ -27,7 +27,7 @@ type: "docs" 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]({{< relref "/release_notes/csit_rls2306/" >}})**: The + - **[CSIT rls2306]({{< relref "/release_notes/current/" >}})**: The release notes of the current CSIT release. - **[Previous]({{< relref "/release_notes/previous/" >}})**: Archived release notes for the past releases. diff --git a/docs/content/overview/csit/_index.md b/docs/content/overview/csit/_index.md index 2a004ce314..167c872c0b 100644 --- a/docs/content/overview/csit/_index.md +++ b/docs/content/overview/csit/_index.md @@ -3,4 +3,43 @@ bookCollapseSection: true bookFlatSection: false title: "CSIT" weight: 2 ---- \ No newline at end of file +--- + +# Continuous System Integration and Testing + +## CSIT Description + +1. Development of software code for fully automated VPP code testing, + functionality, performance, regression and new functions. +2. Execution of CSIT test suites on VPP code running on LF FD.io virtual and + physical compute environments. +3. Integration with FD.io continuous integration systems (Gerrit, Jenkins and + such). +4. Identified existing FD.io project dependencies and interactions: + - vpp - Vector Packet Processing. + - ci-management - Management repo for Jenkins Job Builder, script and + management related to the Jenkins CI configuration. + +## Project Scope + +1. Automated regression testing of VPP code changes + - Functionality of VPP data plane, network control plane, management plane + against functional specifications. + - Performance of VPP data plane including non-drop-rate packet throughput + and delay, against established reference benchmarks. + - Performance of network control plane against established reference + benchmarks. + - Performance of management plane against established reference benchmarks. +2. Test case definitions driven by supported and planned VPP functionality, + interfaces and performance: + - Uni-dimensional tests: Data plane, (Network) Control plane, Management + plane. + - Multi-dimensional tests: Use case driven. +3. Integration with FD.io Continuous Integration system including FD.io Gerrit + and Jenkins + - Automated test execution triggered by VPP-VERIFY jobs other VPP and CSIT + project jobs. +4. Integration with LF VPP test execution environment + - Functional tests execution on LF hosted VM environment. + - Performance and functional tests execution on LF hosted physical compute + environment. diff --git a/docs/content/release_notes/csit_rls2306/_index.md b/docs/content/release_notes/current/_index.md similarity index 92% rename from docs/content/release_notes/csit_rls2306/_index.md rename to docs/content/release_notes/current/_index.md index c23655ee89..a231195b8c 100644 --- a/docs/content/release_notes/csit_rls2306/_index.md +++ b/docs/content/release_notes/current/_index.md @@ -15,10 +15,10 @@ Previous CSIT releases are also linked from there. ## CSIT-2306 Release Notes -- [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" >}}) +- [VPP Performance]({{< relref "vpp_performance" >}}) +- [DPDK Performance]({{< relref "dpdk_performance" >}}) +- [TRex Performance]({{< relref "trex_performance" >}}) +- [VPP Device]({{< relref "vpp_device" >}}) ## CSIT-2306 Release Data diff --git a/docs/content/release_notes/csit_rls2306/dpdk_performance.md b/docs/content/release_notes/current/dpdk_performance.md similarity index 100% rename from docs/content/release_notes/csit_rls2306/dpdk_performance.md rename to docs/content/release_notes/current/dpdk_performance.md diff --git a/docs/content/release_notes/csit_rls2306/trex_performance.md b/docs/content/release_notes/current/trex_performance.md similarity index 100% rename from docs/content/release_notes/csit_rls2306/trex_performance.md rename to docs/content/release_notes/current/trex_performance.md diff --git a/docs/content/release_notes/csit_rls2306/vpp_device.md b/docs/content/release_notes/current/vpp_device.md similarity index 100% rename from docs/content/release_notes/csit_rls2306/vpp_device.md rename to docs/content/release_notes/current/vpp_device.md diff --git a/docs/content/release_notes/csit_rls2306/vpp_performance.md b/docs/content/release_notes/current/vpp_performance.md similarity index 100% rename from docs/content/release_notes/csit_rls2306/vpp_performance.md rename to docs/content/release_notes/current/vpp_performance.md diff --git a/docs/content/release_notes/previous/_index.md b/docs/content/release_notes/previous/_index.md index 601c7aa295..4562e30223 100644 --- a/docs/content/release_notes/previous/_index.md +++ b/docs/content/release_notes/previous/_index.md @@ -7,4 +7,4 @@ weight: 2 # Previous Releases -- [CSIT rls2302]({{< relref "/release_notes/previous/csit_rls2302" >}}) +- [CSIT rls2302]({{< relref "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 9f193c5814..1b787fdd69 100644 --- a/docs/content/release_notes/previous/csit_rls2302/_index.md +++ b/docs/content/release_notes/previous/csit_rls2302/_index.md @@ -7,7 +7,7 @@ weight: 1 # CSIT rls2302 -- [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" >}}) +- [VPP Performance]({{< relref "vpp_performance" >}}) +- [DPDK Performance]({{< relref "dpdk_performance" >}}) +- [TRex Performance]({{< relref "trex_performance" >}}) +- [VPP Device]({{< relref "vpp_device" >}}) -- 2.16.6