[YUNIKORN-2400] Upgrade docusaurus to 3.x (apache#421)

Upgrade docusaurus to 3.2 Closes: apache#421 Signed-off-by: Yu-Lin Chen <[email protected]>
pbacsko · Apr 23, 2024 · 328499b · 328499b
1 parent c1a31ec
commit 328499b
Show file tree

Hide file tree

Showing 36 changed files with 3,511 additions and 2,852 deletions.
diff --git a/docs/design/user_group_enforcement.md b/docs/design/user_group_enforcement.md
@@ -387,8 +387,8 @@ The quota set in the queueTracker at the specific entry is the quota that is enf
 From a troubleshooting perspective this would be a requirement to allow an administrator to assess state.
 
 Based on the current REST api definition the data exposed in the following two endpoints will be updated to expose the limits:  
-_/ws/v1/partition/{partitionName}/usage/users_  
-_/ws/v1/partition/{partitionName}/usage/groups_  
+_/ws/v1/partition/\{partitionName\}/usage/users_  
+_/ws/v1/partition/\{partitionName\}/usage/groups_  
 
 For both endpoints we expose the full queue hierarchy. As an example below the approximate output for the users endpoint for one user:
 

diff --git a/docs/design/user_group_manager.md b/docs/design/user_group_manager.md
@@ -331,8 +331,8 @@ The usage tracking information that is part of the user group manager must be ex
 
 Based on the current REST api definition for other object the proposal is to expose the following new endpoints:
 
-- /ws/v1/partition/{partitionName}/usage/users
-- /ws/v1/partition/{partitionName}/usage/groups
+- /ws/v1/partition/\{partitionName\}/usage/users
+- /ws/v1/partition/\{partitionName\}/usage/groups
 
 For both endpoints we expose the full queue hierarchy. As an example below the approximate output for the user's endpoint for one user:
 

diff --git a/docs/performance/evaluate_perf_function_with_kwok.md b/docs/performance/evaluate_perf_function_with_kwok.md
@@ -31,7 +31,7 @@ Using Kwok, we replicated previous performance tests, deploying 10 deployments o
 
 The test is conducted using KWOK in a Cluster. The cluster environment is optimized according to the performance tuning settings in the YuniKorn documentation. For more details, refer to the [Benchmarking Tutorial](performance/performance_tutorial.md#performance-tuning). You can conveniently set up Kwok in your Kubernetes Cluster by downloading the scripts we provide [here](https://github.com/apache/yunikorn-k8shim/blob/master/deployments/kwok-perf-test/kwok-setup.sh). 
 
-For data monitoring, Prometheus will be employed to gather metrics. We'll use count(kube_pod_status_scheduled_time{namespace="default"}) as an indicator of throughput.
+For data monitoring, Prometheus will be employed to gather metrics. We'll use count(kube_pod_status_scheduled_time\{namespace="default"\}) as an indicator of throughput.
 
 ## Test Cases
 

diff --git a/docs/user_guide/preemption.md b/docs/user_guide/preemption.md
@@ -91,7 +91,7 @@ We will deploy 10 pods with a resource requirement of 1 to both `queue-1` and `q
 
 Result:
 
-When a set of guaranteed resources is defined, preemption aims to ensure that all queues satisfy their guaranteed resources. Preemption stops once the guaranteed resources are met (law 4). A queue may be preempted if it has more resources than its guaranteed amount. For instance, in this case, if queue-1 has fewer resources than its guaranteed amount (<5), it will not be preempted (law 5).
+When a set of guaranteed resources is defined, preemption aims to ensure that all queues satisfy their guaranteed resources. Preemption stops once the guaranteed resources are met (law 4). A queue may be preempted if it has more resources than its guaranteed amount. For instance, in this case, if queue-1 has fewer resources than its guaranteed amount (\<5), it will not be preempted (law 5).
 
 | Queue            | Resource before preemption | Resource after preemption |
 | ---------------- | -------------------------- | ------------------------- |

diff --git a/docs/user_guide/service_config.md b/docs/user_guide/service_config.md
@@ -733,7 +733,7 @@ Example:
 log.level: "DEBUG"
 ```
 
-#### log.{subsystem}.level
+#### log.\{subsystem\}.level
 Sets the verbosity that YuniKorn subsystem will log at.
 
 Yunikorn allows fine-grained logging configuration in a hierarchical manner. For example, 

diff --git a/docs/user_guide/use_case.md b/docs/user_guide/use_case.md
@@ -376,8 +376,8 @@ The results of deploying Pods in different queues are shown below. You can use t
 
 | user, group  | Resource Limits for Destination Queues | request resources for each replicas | replica | result                                                   | YAML filename    |
 |--------------|----------------------------------------|-------------------------------------|---------|----------------------------------------------------------|------------------|
-| admin, admin | {memory: 6G, vcore: 6}                 | {memory: 512M, vcore: 250m}         | 1       | run all replica                                          | nginx-admin.yaml |
-| sue, group-A | {memory: 2G, vcore: 4}                 | {memory: 512M, vcore: 500m}         | 5       | run 3 replica (4 replica will exceed the resource limit) | nginx-sue.yaml   |
+| admin, admin | \{memory: 6G, vcore: 6\}                 | \{memory: 512M, vcore: 250m\}         | 1       | run all replica                                          | nginx-admin.yaml |
+| sue, group-A | \{memory: 2G, vcore: 4\}                 | \{memory: 512M, vcore: 500m\}         | 5       | run 3 replica (4 replica will exceed the resource limit) | nginx-sue.yaml   |
 
 See the documentation on [Partition and Queue Configuration #Resources](queue_config#resources) for more information.
 

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -203,7 +203,7 @@ module.exports = {
             },
             {
               label: 'People',
-              href: 'community/people'
+              to: 'community/people'
             },
             {
               label: 'Issues',

diff --git a/package.json b/package.json
@@ -11,15 +11,15 @@
     "release": "docusaurus docs:version"
   },
   "dependencies": {
-    "@docusaurus/core": "2.4.1",
-    "@docusaurus/preset-classic": "2.4.1",
-    "@docusaurus/theme-search-algolia": "2.4.1",
-    "@mdx-js/react": "^1.5.8",
-    "axios": "0.28.0",
-    "clsx": "^1.1.1",
-    "node": "^18.8.0",
-    "react": "17.0.2",
-    "react-dom": "17.0.2"
+    "@docusaurus/core": "3.2.1",
+    "@docusaurus/preset-classic": "3.2.1",
+    "@docusaurus/theme-search-algolia": "3.2.1",
+    "@mdx-js/react": "^3.0.1",
+    "axios": "1.6.8",
+    "clsx": "^2.1.0",
+    "node": "^18.20.1",
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
   },
   "browserslist": {
     "production": [