Pull Request for Docusaurus V3 Migration

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16.14.0-alpine3.15 as builder
+FROM node:18.2.0-alpine as builder
 WORKDIR /build
 COPY . ./
 COPY ./images/ ./static/images

docusaurus.config.js

@@ -1,8 +1,9 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+const { themes } = require('prism-react-renderer');
+const lightCodeTheme = themes.github;
+const darkCodeTheme = themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -18,6 +19,7 @@ const config = {
   // If you aren't using GitHub pages, you don't need these.
   organizationName: 'kubeslice', // Usually your GitHub org/user name.
   projectName: 'docs', // Usually your repo name.
+  staticDirectories:['static', 'images'],
 
   // Even if you don't use internalization, you can use this field to set useful
   // metadata like html lang. For example, if your site is Chinese, you may want

package.json

@@ -15,21 +15,21 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "3.1.0",
-    "@docusaurus/plugin-content-blog": "^3.1.0",
-    "@docusaurus/plugin-google-gtag": "^3.1.0",
-    "@docusaurus/preset-classic": "3.1.0",
-    "@mdx-js/react": "^1.6.22",
-    "clsx": "^1.1.1",
+    "@docusaurus/core": "3.4.0",
+    "@docusaurus/plugin-content-blog": "^3.4.0",
+    "@docusaurus/plugin-google-gtag": "^3.4.0",
+    "@docusaurus/preset-classic": "3.4.0",
+    "@mdx-js/react": "^3.0.0",
+    "clsx": "^2.1.1",
     "docusaurus-gtm-plugin": "^0.0.2",
     "docusaurus-plugin-sass": "^0.2.5",
-    "prism-react-renderer": "^1.3.3",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "prism-react-renderer": "^2.3.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.21",
-    "sass": "^1.54.0"
+       "@docusaurus/module-type-aliases": "^3.4.0",
+    "sass": "^1.69.5"
   },
   "browserslist": {
     "production": [

src/theme/DocVersionBanner/index.js

@@ -7,11 +7,11 @@ import {
   useActivePlugin,
   useDocVersionSuggestions,
 } from '@docusaurus/plugin-content-docs/client';
+import {ThemeClassNames} from '@docusaurus/theme-common';
 import {
-  ThemeClassNames,
   useDocsPreferredVersion,
   useDocsVersion,
-} from '@docusaurus/theme-common';
+} from '@docusaurus/theme-common/internal';
 function UnreleasedVersionLabel({siteTitle, versionMetadata}) {
   return (
     <Translate
@@ -37,7 +37,7 @@ function UnmaintainedVersionLabel({siteTitle, versionMetadata}) {
         versionLabel: <b>{versionMetadata.label}</b>,
       }}>
       {
-        'This is documentation for {siteTitle} {versionLabel}, which is an older version.'
+        'This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.'
       }
     </Translate>
   );
@@ -71,7 +71,7 @@ function LatestVersionSuggestionLabel({versionLabel, to, onClick}) {
         ),
       }}>
       {
-        'For the latest documentation, see the {latestVersionLink} ({versionLabel}).'
+        'For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).'
       }
     </Translate>
   );

src/theme/NotFound/Content/index.js

@@ -0,0 +1,36 @@
+import React from 'react';
+import clsx from 'clsx';
+import Translate from '@docusaurus/Translate';
+import Heading from '@theme/Heading';
+export default function NotFoundContent({className}) {
+  return (
+    <main className={clsx('container margin-vert--xl', className)}>
+      <div className="row">
+        <div className="col col--6 col--offset-3">
+          <Heading as="h1" className="hero__title">
+            <Translate
+              id="theme.NotFound.title"
+              description="The title of the 404 page">
+              Page Not Found
+            </Translate>
+          </Heading>
+          <p>
+            <Translate
+              id="theme.NotFound.p1"
+              description="The first paragraph of the 404 page">
+              We could not find what you were looking for.
+            </Translate>
+          </p>
+          <p>
+            <Translate
+              id="theme.NotFound.p2"
+              description="The 2nd paragraph of the 404 page">
+              Please contact the owner of the site that linked you to the
+              original URL and let them know their link is broken.
+            </Translate>
+          </p>
+        </div>
+      </div>
+    </main>
+  );
+}

versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx

@@ -12,8 +12,7 @@ Before you begin, ensure the following prerequisites are met:
 see [Installing the KubeSlice Controller](/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx).
 - You have registered two or more worker clusters with the KubeSlice Controller. For more information, 
 see [Registering the Worker Cluster](/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx).
-- You have installed Istio in the worker clusters to configure the external gateways. For more information, 
-see [Installing Istio](/versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx#installing-istio).
+- You have installed Istio in the worker clusters to configure the external gateways.
 
 ## Creating the Slice YAML File
 
@@ -255,9 +254,9 @@ The following information is required.
 
 |Variable|Description|
 |----|----|
-|<cluster name\>|The name of the cluster.|
-|<slice configuration\>|The name of the slice configuration file.|
-|<project namespace\>|The project namespace on which you apply the slice configuration file.|
+|`<cluster name>`|The name of the cluster.|
+|`<slice configuration>`|The name of the slice configuration file.|
+|`<project namespace>`|The project namespace on which you apply the slice configuration file.|
 
 Perform these steps:
 

versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx

@@ -116,8 +116,8 @@ The following information is required.
 
 |Parameter|Description|
 |----|----|
-|<cluster name\>|The name of the cluster.|
-|<values\>|The name of the values file.|
+|`<cluster name>`|The name of the cluster.|
+|`<values >`|The name of the values file.|
 
 Use the following command to apply the YAML:
 ```
@@ -196,7 +196,7 @@ The following information is required.
 
 |Parameter|Description|
 |-----|-----|
-|<project name\>|The given name of the project YAML file.|
+|<project name />|The given name of the project YAML file.|
 
 Use the following command to apply the YAML file:
 ``` 

versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx

@@ -155,9 +155,9 @@ The following information is required.
 
 |Values|Description|
 |----|----|
-|<cluster name\>|The name of the cluster.|
-|<cluster registration\>|The name of the registration file.|
-|<project namespace\>|The namespace of your project.|
+|`<cluster name>`|The name of the cluster.|
+|`<cluster registration>`|The name of the registration file.|
+|`<project namespace>`|The namespace of your project.|
 
 Perform these steps:
 
@@ -373,8 +373,8 @@ The following information is required to apply the YAML file.
 
 |Parameter|Description|
 |----|----|
-|<cluster name\>|The name of the cluster.|
-|<values\>|The file name with the values.|
+|`<cluster name>`|The name of the cluster.|
+|`<values>`|The file name with the values.|
 
 Perform these steps:
 

versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/prerequisites/preparing-the-cloud-clusters-for-registration.mdx

@@ -25,8 +25,8 @@ Kubernetes Service (AKS) `kubeconfig`.
 
 | **Variable**      |        **Description** |
 |-----|-----|
-| <resource group name\> |  The name of the resource group the cluster belongs to.
-  <cluster name\>         | The name of the cluster you would like to get credentials for.|
+| `<resource group name>` |  The name of the resource group the cluster belongs to.
+  `<cluster name>`         | The name of the cluster you would like to get credentials for.|
 
 The following command retrieves your AKS cluster `kubeconfig` and add it to your default `kubeconfig` path. Complete this step for each
 AKS cluster that you want to work with.
@@ -43,8 +43,8 @@ Service (EKS) `kubeconfig`.
 
 | **Variable**  |     **Description** |
 |-----|----|
-|<cluster name\>  | The name of the cluster you want to get credentials for.|
-|  <cluster region\>       |  The AWS region the cluster belongs to.|
+|`<cluster name>`  | The name of the cluster you want to get credentials for.|
+|  `<cluster region>`       |  The AWS region the cluster belongs to.|
 
 The following command retrieves your EKS cluster `kubeconfig` and adds
 it to your default `kubeconfig` path. Complete this step for each EKS
@@ -62,9 +62,9 @@ Engine (GKE) `kubeconfig`.
 
 | **Variable**  |     **Description** |
 |-----|----|
-|<cluster name\>  | The name of the cluster you want to get credentials for.|
-|  <region\>       |  The region the cluster belongs to.|
-| <project id\>    | The project ID that the cluster belongs to.|
+|`<cluster name>`  | The name of the cluster you want to get credentials for.|
+|  `<region>`       |  The region the cluster belongs to.|
+| `<project id>`    | The project ID that the cluster belongs to.|
 
 
 The following command retrieves your GKE cluster `kubeconfig` and adds
@@ -116,10 +116,10 @@ The following information is required to label the GKE cluster nodepools.
 
 |**Variable** |       **Description** |
 |-----|----|
-|<nodepool name\>|   The name of the nodepool being labeled.|
-|<cluster name\>  |  The name of the cluster the nodepool being labeled belongs to.|
-|  <region\>      |    The Compute Engine region for the cluster the nodepool belongs to.|
-|  <zone\>         |   The Compute Engine zone for the cluster the nodepool belongs to.|
+|`<nodepool name>`|   The name of the nodepool being labeled.|
+|`<cluster name>`  |  The name of the cluster the nodepool being labeled belongs to.|
+|  `<region>`      |    The Compute Engine region for the cluster the nodepool belongs to.|
+|  `<zone>`         |   The Compute Engine zone for the cluster the nodepool belongs to.|
 
 The following command labels the GKE cluster nodepool: 
 

versioned_docs/version-0.2.0/getting-started-with-cloud-clusters/uninstalling-kubeslice/offboarding-namespaces.mdx

@@ -23,9 +23,9 @@ automatically on all the clusters of the slice.
 
 | Variables | Description |
 |-------------------------|--------------------------------------------------------- 
-| <cluster name\> | The name of the cluster the application is deployed on.|
-|<serviceexport name\> | The name of the service export that you want to delete.|
-| <namespace\> | The namespace the application is deployed on.|
+| `<cluster name>` | The name of the cluster the application is deployed on.|
+|`<serviceexport name>` | The name of the service export that you want to delete.|
+| `<namespace>` | The namespace the application is deployed on.|
 
 Switch the contexts to the cluster you deployed the application on:
 

versioned_docs/version-0.2.0/getting-started-with-kind-clusters.mdx

@@ -11,11 +11,10 @@ free to join our [community](/versioned_docs/version-0.2.0/community.mdx).
 The following sections help you to:
 
 -   Install the KubeSlice Controller on the controller cluster
--   Register the worker clusters on the controller cluster and install
-    the Slice Operator (Worker Operator) on the worker clusters
+-   Register worker clusters on the controller cluster and install
+    the Slice Operator (Worker Operator) on worker clusters
 -   Create a slice
--   Test the connectivity between the worker clusters using the iPerf
-    tool
+-   Test the connectivity between the worker clusters using the iPerf tool
 
 The following diagram shows the topology of KubeSlice installed on
 kind clusters.
@@ -861,8 +860,7 @@ Before you begin, ensure the following prerequisites are met:
 
 - You have the KubeSlice Controller installed on a separate cluster. For more information, 
 see [Installing the KubeSlice Controller](#installing-the-kubeslice-controller).
-- You have registered two or more worker clusters with the KubeSlice Controller. For more 
-information, see [Registering the Worker Cluster](#registering-the-worker-cluster).
+- You have registered two or more worker clusters with the KubeSlice Controller.
 
 ### Creating the Slice YAML File 
 After successfully registering the worker clusters with the KubeSlice Controller, create 

versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/configuration-parameters.mdx

@@ -192,7 +192,7 @@ These parameters are related to the spec configured  in the
 | sliceIpamType | String | It is the type of the IP address management for the slice subnet. The value must be always set to `Local`. | Mandatory |
 | clusters | List of Strings | The names of the worker clusters that would be part of the slice. You can provide the list of worker clusters. | Mandatory |
 | [qosProfileDetails](#qos-profile-parameters) | Object | QoS profile for the slice inter cluster traffic. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters.  | Mandatory |
-| [standardQosProfileName](#standard-qos-profile-parameters) | String | This [name](#slice-qos-profile-metadata-parameter) of the [external QoS profile](/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx#creating-a-qos-profile) that you can apply for multiple slices. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
+| [standardQosProfileName](#qos-profile-parameters) | String | This name of the external QoS profile that you can apply for multiple slices. Note that `qosProfileDetails` and `standardQosProfileName` are mutually exclusive parameters. | Mandatory |
 | [namespaceIsolationProfile](#namespace-isolation-profile-parameters) | Object | It is the configuration to onboard namespaces and/or isolate namespaces with the network policy. | Mandatory |
 | [externalGatewayConfig](#external-gateway-configuration-parameters) | Object | It is the slice ingress/egress gateway configuration. It is an optional configuration. | Mandatory |
 
@@ -267,7 +267,7 @@ Parameter|Parameter Type|Description|Required|
 |----|----|----|----|
 | apiVersion | String | The KubeSlice Controller API version. A set of resources that are exposed together, along with the version. The value must be `networking.kubeslice.io/v1beta1`. | Mandatory |
 | kind | String | The name of a particular object schema. The value must be `SliceQoSConfig`. | Mandatory |
-| [metadata](#standard-qos-profile-metadata-parameters) | Object | The metadata describes parameters (names and types) and attributes that have been applied. | Mandatory |
+| [metadata](#standard-qos-profile-metadata-parameter) | Object | The metadata describes parameters (names and types) and attributes that have been applied. | Mandatory |
 | [spec](#standard-qos-profile-specification-parameters) | Object | The specification of the desired state of an object. | Mandatory |
 
 ### Standard QoS Profile Metadata Parameter

versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/creating-a-slice.mdx

@@ -12,8 +12,7 @@ Before you begin, ensure the following prerequisites are met:
 see [Installing the KubeSlice Controller](/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx).
 - You have registered two or more worker clusters with the KubeSlice Controller. For more information, 
 see [Registering the Worker Cluster](/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/registering-the-worker-cluster.mdx).
-- You have installed Istio in the worker clusters to configure the external gateways. For more information, 
-see [Installing Istio](/versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx#installing-istio).
+- You have installed Istio in the worker clusters to configure the external gateways.
 
 ## Creating the Slice YAML File
 
@@ -292,9 +291,9 @@ The following information is required.
 
 |Variable|Description|
 |----|----|
-|<cluster name\>|The name of the cluster.|
-|<slice configuration\>|The name of the slice configuration file.|
-|<project namespace\>|The project namespace on which you apply the slice configuration file.|
+|`<cluster name>`|The name of the cluster.|
+|`<slice configuration>`|The name of the slice configuration file.|
+|`<project namespace>`|The project namespace on which you apply the slice configuration file.|
 
 Perform these steps:
 

versioned_docs/version-0.3.0/getting-started-with-cloud-clusters/installing-kubeslice/installing-the-kubeslice-controller.mdx

@@ -116,8 +116,8 @@ The following information is required.
 
 |Parameter|Description|
 |----|----|
-|<cluster name\>|The name of the cluster.|
-|<values\>|The name of the values file.|
+|`<cluster name>`|The name of the cluster.|
+|`<values>`|The name of the values file.|
 
 Use the following command to apply the YAML:
 ```
@@ -196,7 +196,7 @@ The following information is required.
 
 |Parameter|Description|
 |-----|-----|
-|<project name\>|The given name of the project YAML file.|
+|`<project name>`|The given name of the project YAML file.|
 
 Use the following command to apply the YAML file:
 ```