From 094e41ef2cacf3ebbbe9e29a3dd592c36d0b6afd Mon Sep 17 00:00:00 2001
From: facchettos <facchettos@gmail.com>
Date: Thu, 30 Nov 2023 14:05:10 +0100
Subject: [PATCH] fixing the docs

---
 .../load-testing/results.mdx                  | 24 +++++++++----------
 .../load-testing/setup.mdx                    |  0
 docs/sidebars.js                              |  9 +++++++
 3 files changed, 21 insertions(+), 12 deletions(-)
 rename docs/pages/{ => advanced-topics}/load-testing/results.mdx (76%)
 rename docs/pages/{ => advanced-topics}/load-testing/setup.mdx (100%)

diff --git a/docs/pages/load-testing/results.mdx b/docs/pages/advanced-topics/load-testing/results.mdx
similarity index 76%
rename from docs/pages/load-testing/results.mdx
rename to docs/pages/advanced-topics/load-testing/results.mdx
index 51da5e4912..f02165168c 100644
--- a/docs/pages/load-testing/results.mdx
+++ b/docs/pages/advanced-topics/load-testing/results.mdx
@@ -4,7 +4,7 @@ sidebar_label: Load Tests
 ---
 
 ## Summary
-This document includes performance test results of Kubernetes API using various vCluster and K8s distributions and configurations. 
+This document includes performance test results of Kubernetes API using various vCluster and K8s distributions and configurations.
 This is a TL;DR of the test results, the detailed results can be found below. During our tests, K3s with SQLite lagged behind other distributions when running high intensity loads. However, for less intensive usage and a more simple deployment, it was only marginally slower than the others while staying well within the usable range.
 If you plan on having high api usage in your vClusters, we recommend using an etcd backed distribution as you will most likely experience timeouts or throttling with the sqlite backed distribution. For less intense usage, K3s with SQLite will be as adequate as the others.
 
@@ -12,7 +12,7 @@ If you plan on having high api usage in your vClusters, we recommend using an et
 ## API Response Times
 
 <figure>
-  <img src="/docs/media/diagrams/apiserver-latency-baseline.svg" alt="apiserver-avg-baseline" />
+  <img src="/docs/media/apiserver-latency-baseline.svg" alt="apiserver-avg-baseline" />
   <figcaption>APIserver average response time (baseline)</figcaption>
 </figure>
 
@@ -20,7 +20,7 @@ During our baseline testing (300 secrets, 30qps), K3s with SQLite was significan
 
 
 <figure>
-  <img src="/docs/media/diagrams/apiserver-latency-intensive.svg" alt="apiserver-avg-intensive" />
+  <img src="/docs/media/apiserver-latency-intensive.svg" alt="apiserver-avg-intensive" />
   <figcaption>APIserver average response time (intensive)</figcaption>
 </figure>
 
@@ -28,7 +28,7 @@ For our more intensive testing (5000 secrets, 200qps), the differences between t
 
 
 <figure>
-  <img src="/docs/media/diagrams/cumu-distribution-apiserver.svg" alt="apiserver-cumu-dist-intensive" />
+  <img src="/docs/media/cumu-distribution-apiserver.svg" alt="apiserver-cumu-dist-intensive" />
   <figcaption>Cumulative distribution of request time during the intensive testing</figcaption>
 </figure>
 
@@ -37,17 +37,17 @@ For our more intensive testing (5000 secrets, 200qps), the differences between t
 During our testing, most distributions had similar CPU usage, with the exception of k3s with SQLite which had a higher CPU usage, most likely due to having to convert etcd requests into SQLite ones.
 
 <figure>
-  <img src="/docs/media/diagrams/cpu-sn-baseline.svg" alt="cpu usage (baseline)" />
+  <img src="/docs/media/cpu-sn-baseline.svg" alt="cpu usage (baseline)" />
   <figcaption>CPU usage during the baseline test</figcaption>
 </figure>
 
 <figure>
-  <img src="/docs/media/diagrams/cpu-sn-intensive.svg" alt="cpu usage (intensive)" />
+  <img src="/docs/media/cpu-sn-intensive.svg" alt="cpu usage (intensive)" />
   <figcaption>CPU usage during the intensive test</figcaption>
 </figure>
 
 <figure>
-  <img src="/docs/media/diagrams/cpu-intensive-ha.svg" alt="cpu usage (intensive) for ha setups" />
+  <img src="/docs/media/cpu-intensive-ha.svg" alt="cpu usage (intensive) for ha setups" />
   <figcaption>CPU usage during the intensive test (ha setups)</figcaption>
 </figure>
 
@@ -56,17 +56,17 @@ During our testing, most distributions had similar CPU usage, with the exception
 Memory usage was relatively similar in all setups
 
 <figure>
-  <img src="/docs/media/diagrams/mem-usage-baseline.svg" alt="memory usage over time sn setup" />
+  <img src="/docs/media/mem-usage-baseline.svg" alt="memory usage over time sn setup" />
   <figcaption>Memory usage during the baseline test</figcaption>
 </figure>
 
 <figure>
-  <img src="/docs/media/diagrams/mem-usage-intensive.svg" alt="memory usage over time sn setup" />
+  <img src="/docs/media/mem-usage-intensive.svg" alt="memory usage over time sn setup" />
   <figcaption>Memory usage during the intensive test</figcaption>
 </figure>
 
 <figure>
-  <img src="/docs/media/diagrams/mem-usage-ha.svg" alt="memory usage over time sn setup" />
+  <img src="/docs/media/mem-usage-ha.svg" alt="memory usage over time sn setup" />
   <figcaption>Memory usage during the intensive test with HA setups</figcaption>
 </figure>
 
@@ -75,11 +75,11 @@ Memory usage was relatively similar in all setups
 The filesystem usage was higher in the k3s SQLite version compared to all etcd backed versions in the intensive setup. In the baseline setup there was little to no usage of the filesystem
 
 <figure>
-  <img src="/docs/media/diagrams/fs-write-intensive.svg" alt="fs usage over time" />
+  <img src="/docs/media/fs-write-intensive.svg" alt="fs usage over time" />
   <figcaption>Filesystem writes over time</figcaption>
 </figure>
 <figure>
-  <img src="/docs/media/diagrams/fs-read-intensive.svg" alt="memory usage over time sn setup" />
+  <img src="/docs/media/fs-read-intensive.svg" alt="memory usage over time sn setup" />
   <figcaption>Filesystem reads over time</figcaption>
 </figure>
 
diff --git a/docs/pages/load-testing/setup.mdx b/docs/pages/advanced-topics/load-testing/setup.mdx
similarity index 100%
rename from docs/pages/load-testing/setup.mdx
rename to docs/pages/advanced-topics/load-testing/setup.mdx
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 5072d285e4..2c24b8a063 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -239,6 +239,15 @@ module.exports = {
             "advanced-topics/plugins-development",
           ],
         },
+        {
+          type: "category",
+          label: "Load Testing",
+          collapsed: true,
+          items: [
+            "advanced-topics/load-testing/setup",
+            "advanced-topics/load-testing/results",
+          ],
+        },
         "advanced-topics/telemetry",
       ],
     },