Docusaurus 3 upgrade for Version 4.0

.gitignore

@@ -35,7 +35,7 @@ link_report.*
 palette-docs.pdf
 
 docs/api-content/api-docs/v1/*.mdx
-docs/api-content/api-docs/v1/sidebar.js
+docs/api-content/api-docs/v1/sidebar.*
 
 # Versions Content
 versions.json

apisidebar.js

@@ -11,6 +11,14 @@
 //   versionCrumb,
 // } = require("docusaurus-plugin-openapi-docs/lib/sidebars/utils");
 
+const fs = require('fs');
+const sidebarFilePath = './docs/api-content/api-docs/v1/sidebar.ts';
+
+let sidebarItems = [];
+if (fs.existsSync(sidebarFilePath)) {
+  sidebarItems = require(sidebarFilePath);
+}
+
 module.exports = {
   apiSidebar: [
     {
@@ -35,13 +43,7 @@ module.exports = {
         type: "generated-index",
         title: "Palette API V1",
       },
-      items: (() => {
-        try {
-          return require("./docs/api-content/api-docs/v1/sidebar.js");
-        } catch (error) {
-          return [];
-        }
-      })(),
+      items: sidebarItems,
     },
   ],
 };

docs/api-content/api-docs/1-introduction.md

@@ -194,7 +194,7 @@ The API rate limits are as follows:
 | /v1/overlords | 10 | 5 | 50 |
 | /v1/cluster | 10 | 5 | 50 |
 | /v1/cloudconfigs | 10 | 5 | 50 |
-| /v1/cloudconfigs/{cloudType}/{uid}/machinePools | 10 | 5 | 50 |
+| /v1/cloudconfigs/\{cloudType}/\{uid}/machinePools | 10 | 5 | 50 |
 | /v1/edgehosts | 10 | 5 | 50 |
 | /v1/metrics | 10 | 5 | 50 |
 | /v1/system | 10 | 5 | 50 |
@@ -203,8 +203,8 @@ The API rate limits are as follows:
 | /v1/clouds | 10 | 5 | 50 |
 | /v1/events/components | 10 | 5 | 50 |
 | /v1/dashboard | 10 | 5 | 50 |
-| /v1/cloudconfigs/{cloudType}/:uid/machinePools/{machinePoolName}/machines | 10 | 5 | 50 |
-| /v1/cloudconfigs/{cloudType}/:uid/machinePools/{machinePoolName}/machines/:machineUid | 10 | 5 | 50 |
+| /v1/cloudconfigs/\{cloudType}/:uid/machinePools/\{machinePoolName}/\machines | 10 | 5 | 50 |
+| /v1/cloudconfigs/\{cloudType}/:uid/machinePools/\{machinePoolName}/\machines/:machineUid | 10 | 5 | 50 |
 | /v1/auth/authenticate | 10 | 5 | 50 |
 | /v1/auth/services/login | 10 | 5 | 50 |
 | /v1/auth/services/edge/login | 10 | 5 | 50 |
@@ -223,7 +223,7 @@ The API rate limits are as follows:
 | /v1/clusterprofiles | 50 | 5 | 250 |
 | /v1/clusterprofiles/:uid/packs | 50 | 5 | 250 |
 | /v1/clusterprofiles/:uid/packs/manifests | 50 | 5 | 250 |
-| /v1/clusterprofiles/:uid/packs/{packName}/manifests | 50 | 5 | 250 |
+| /v1/clusterprofiles/:uid/packs/\{packName}/manifests | 50 | 5 | 250 |
 | /v1/clusterprofiles/validate/packs | 50 | 5 | 250 |
 | /v1/clusterprofiles/:uid/validate/packs | 50 | 5 | 250 |
 | /v1/spectroclusters/:uid/profiles | 50 | 5 | 250 |

docs/api-content/api-docs/v1/api.json

@@ -2826,7 +2826,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean",
           "x-omitempty": false
         }
@@ -3764,7 +3764,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean",
           "x-omitempty": false
         }
@@ -8905,7 +8905,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean"
         }
       },
@@ -10341,7 +10341,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean"
         }
       },
@@ -10753,7 +10753,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean"
         }
       },
@@ -11324,7 +11324,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean",
           "x-omitempty": false
         }
@@ -12292,7 +12292,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean"
         }
       },
@@ -12701,7 +12701,7 @@
           "type": "integer"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean"
         }
       },
@@ -14596,7 +14596,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean"
         },
         "xslTemplate": {
@@ -15417,7 +15417,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean"
         }
       },
@@ -15797,7 +15797,7 @@
           "description": "Rolling update strategy for this machine pool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "If IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "If IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean",
           "x-omitempty": false
         }
@@ -18872,7 +18872,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean"
         }
       },
@@ -30187,7 +30187,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean"
         }
       },
@@ -32000,7 +32000,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean"
         }
       },
@@ -33411,7 +33411,7 @@
       "type": "object"
     },
     "v1VmFieldsV1": {
-      "description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of  a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
+      "description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:\\<index>', where \\<index> is position of a item in a list 'k:<keys>', where <keys> is a map of  a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
       "properties": {
         "Raw": {
           "items": {
@@ -33838,7 +33838,7 @@
           "additionalProperties": {
             "type": "string"
           },
-          "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
+          "description": "matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
           "type": "object"
         }
       },
@@ -35906,7 +35906,7 @@
           "description": "rolling update strategy for this machinepool if not specified, will use ScaleOut"
         },
         "useControlPlaneAsWorker": {
-          "description": "if IsControlPlane==true && useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
+          "description": "if IsControlPlane==true and useControlPlaneAsWorker==true, then will remove master taint this will not be used for worker pools",
           "type": "boolean",
           "x-omitempty": false
         }

docs/docs-content/byoos/image-builder.md

@@ -268,7 +268,7 @@ The following steps guide you through creating your image. You will create a cus
 17. Click on **Next layer** to add the Kubernetes layer.
 
 
-18. Select the desired Kubernetes distribution and version. Click on the **</\>** button to display the YAML editor.
+18. Select the desired Kubernetes distribution and version. Click on the **\</\>** button to display the YAML editor.
 
 
 19. Complete the remainder of the cluster profile creation wizard by selecting the next cluster profile layers.

docs/docs-content/clusters/cluster-groups/create-cluster-group.md

@@ -40,7 +40,7 @@ Use the instructions below to create a cluster group.
 2. Click **+New Cluster Groups** to create a new cluster group and provide the following information to the creation wizard.
 
 
-   * **Basic Information: **
+   * **Basic Information**: 
 
   |         Parameter           | Description  |
   |-------------------------------|-----------------|

docs/docs-content/clusters/cluster-groups/ingress-cluster-group.md

@@ -59,7 +59,7 @@ The following steps describe how to enable an Ingress Controller for a Cluster G
 
     - Existing host clusters that you will add to a new Cluster Group. <br /><br />
 
-3. Either add the `nginx-ingress` add-on profile to each host cluster, or manually configure your own ingress controller add-on profile with the customizations described in the [Prerequisites](ingress-cluster-group.md/#prerequisites) section. 
+3. Either add the `nginx-ingress` add-on profile to each host cluster, or manually configure your own ingress controller add-on profile with the customizations described in the [Prerequisites](ingress-cluster-group.md#prerequisites) section. 
 
   a. From the **Main Menu**, choose **Clusters** and select a cluster.
 

docs/docs-content/clusters/cluster-management/image-swap.md

@@ -141,7 +141,7 @@ Use the following steps to learn how to use Palette's image swap functionality.
 7. Select a Kubernetes distribution and version.
 
 
-8. Next, select the code editor button **</\>** to edit the pack YAML configuration. Within the `pack` section's scope, add your `imageSwap` configuration block. Click on **Next layer** to continue.
+8. Next, select the code editor button **\</\>** to edit the pack YAML configuration. Within the `pack` section's scope, add your `imageSwap` configuration block. Click on **Next layer** to continue.
 
   <br />
 

docs/docs-content/clusters/clusters.md

@@ -224,10 +224,10 @@ At times, you may be required to work with the Palette Support Team to troublesh
 
     This message will display on the UI: "The request was sent successfully. The download will be available soon." There is an average wait time of five (5) minutes. 
 
-    At the end of this short log fetching interval, the message will be displayed on the UI: "The logs archive for {Cluster-name} was created successfully."
+    At the end of this short log fetching interval, the message will be displayed on the UI: "The logs archive for \{Cluster-name} was created successfully."
 
 
-5. Click **Download <*cluster-name*> logs** to download the **Logs** folder to your local machine.
+5. Click **Download \<*cluster-name*> logs** to download the **Logs** folder to your local machine.
 
 
 6. Unzip and rename the Logs folder as per the customer's choice.