C-Docs: New structure

[csit.git] / docs / content / methodology / measurements / data_plane_throughput / data_plane_throughput.md

diff --git a/docs/content/methodology/data_plane_throughput/data_plane_throughput.md b/docs/content/methodology/measurements/data_plane_throughput/data_plane_throughput.md
similarity index 87%
rename from docs/content/methodology/data_plane_throughput/data_plane_throughput.md
rename to docs/content/methodology/measurements/data_plane_throughput/data_plane_throughput.md
index 7ff1d38..865405b 100644 (file)
--- a/docs/content/methodology/data_plane_throughput/data_plane_throughput.md
+++ b/docs/content/methodology/measurements/data_plane_throughput/data_plane_throughput.md
@@ -1,5 +1,5 @@
 ---
-title: "Data Plane Throughput"
+title: "Overview"
 weight: 1
 ---
 
@@ -12,8 +12,8 @@ set of performance test cases implemented and executed within CSIT.
 Following throughput test methods are used:
 
 - MLRsearch - Multiple Loss Ratio search
-- MRR - Maximum Receive Rate
 - PLRsearch - Probabilistic Loss Ratio search
+- MRR - Maximum Receive Rate
 
 Description of each test method is followed by generic test properties
 shared by all methods.
@@ -34,7 +34,7 @@ RFC2544.
 
 MLRsearch tests are run to discover NDR and PDR rates for each VPP and
 DPDK release covered by CSIT report. Results for small frame sizes
-(64b/78B, IMIX) are presented in packet throughput graphs
+(64B/78B, IMIX) are presented in packet throughput graphs
 (Box-and-Whisker Plots) with NDR and PDR rates plotted against the test
 cases covering popular VPP packet paths.
 
@@ -46,10 +46,36 @@ tables.
 
 ### Details
 
-See [MLRSearch]({{< ref "mlrsearch/#MLRsearch" >}}) section for more detail.
+See [MLRSearch]({{< ref "mlr_search/#MLRsearch" >}}) section for more detail.
 MLRsearch is being standardized in IETF in
 [draft-ietf-bmwg-mlrsearch](https://datatracker.ietf.org/doc/html/draft-ietf-bmwg-mlrsearch-01).
 
+## PLRsearch Tests
+
+### Description
+
+Probabilistic Loss Ratio search (PLRsearch) tests discovers a packet
+throughput rate associated with configured Packet Loss Ratio (PLR)
+criteria for tests run over an extended period of time a.k.a. soak
+testing. PLRsearch assumes that system under test is probabilistic in
+nature, and not deterministic.
+
+### Usage
+
+PLRsearch are run to discover a sustained throughput for PLR=10^-7^
+(close to NDR) for VPP release covered by CSIT report. Results for small
+frame sizes (64B/78B) are presented in packet throughput graphs (Box
+Plots) for a small subset of baseline tests.
+
+Each soak test lasts 30 minutes and is executed at least twice. Results are
+compared against NDR and PDR rates discovered with MLRsearch.
+
+### Details
+
+See [PLRSearch]({{< ref "plr_search/#PLRsearch" >}}) methodology section for
+more detail. PLRsearch is being standardized in IETF in
+[draft-vpolak-bmwg-plrsearch](https://tools.ietf.org/html/draft-vpolak-bmwg-plrsearch).
+
 ## MRR Tests
 
 ### Description
@@ -74,42 +100,16 @@ progressions) resulting from data plane code changes.
 MRR tests are also used for VPP per patch performance jobs verifying
 patch performance vs parent. CSIT reports include MRR throughput
 comparisons between releases and test environments. Small frame sizes
-only (64b/78B, IMIX).
+only (64B/78B, IMIX).
 
 ### Details
 
-See [MRR Throughput]({{< ref "mrr_throughput/#MRR Throughput" >}})
+See [MRR Throughput]({{< ref "mrr/#MRR" >}})
 section for more detail about MRR tests configuration.
 
 FD.io CSIT performance dashboard includes complete description of
-[daily performance trending tests](https://s3-docs.fd.io/csit/master/trending/methodology/performance_tests.html)
-and [VPP per patch tests](https://s3-docs.fd.io/csit/master/trending/methodology/perpatch_performance_tests.html).
-
-## PLRsearch Tests
-
-### Description
-
-Probabilistic Loss Ratio search (PLRsearch) tests discovers a packet
-throughput rate associated with configured Packet Loss Ratio (PLR)
-criteria for tests run over an extended period of time a.k.a. soak
-testing. PLRsearch assumes that system under test is probabilistic in
-nature, and not deterministic.
-
-### Usage
-
-PLRsearch are run to discover a sustained throughput for PLR=10^-7
-(close to NDR) for VPP release covered by CSIT report. Results for small
-frame sizes (64b/78B) are presented in packet throughput graphs (Box
-Plots) for a small subset of baseline tests.
-
-Each soak test lasts 30 minutes and is executed at least twice. Results are
-compared against NDR and PDR rates discovered with MLRsearch.
-
-### Details
-
-See [PLRSearch]({{< ref "plrsearch/#PLRsearch" >}}) methodology section for
-more detail. PLRsearch is being standardized in IETF in
-[draft-vpolak-bmwg-plrsearch](https://tools.ietf.org/html/draft-vpolak-bmwg-plrsearch).
+[daily performance trending tests]({{< ref "../../trending/analysis" >}})
+and [VPP per patch tests]({{< ref "../../per_patch_testing.md" >}}).
 
 ## Generic Test Properties
 
@@ -126,4 +126,4 @@ properties:
 - Offered packet load is always bi-directional and symmetric.
 - All measured and reported packet and bandwidth rates are aggregate
   bi-directional rates reported from external Traffic Generator
-  perspective.
\ No newline at end of file
+  perspective.