chore: upgrade to docusarus v3 (#1914)

* chore: upgrade to docusarus v3 * docs: modifies api.json file to fix compilation problems * docs: fix tab item on trident page * docs: escape forbidden characters * chore: updated sidebar file * docs: fix broken links * upgrade to 3.1.0 * fix problemaic characters * fix broken links * fix mdx problems * remove console.log * increase pack table test timeout * change pack table search value to displayname * change pack table test time out and change search field to display name * pin vale version --------- Co-authored-by: Lenny Chen <[email protected]> Co-authored-by: Karl Cardenas <[email protected]>
spectrocloud · Jan 11, 2024 · 9e3ffef · 9e3ffef
1 parent cbc06df
commit 9e3ffef
Show file tree

Hide file tree

Showing 50 changed files with 37,789 additions and 68,697 deletions.
diff --git a/.github/workflows/pull_request.yaml b/.github/workflows/pull_request.yaml
@@ -51,6 +51,7 @@ jobs:
           reporter: github-pr-review
           vale_flags: --glob=*.{md} --minAlertLevel=error
           fail_on_error: false
+          version: 2.28.2
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 

diff --git a/.gitignore b/.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

diff --git a/apisidebar.js b/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,
     },
   ],
 };
diff --git a/docs/api-content/api-docs/1-introduction.md b/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 |
diff --git a/docs/api-content/api-docs/v1/api.json b/docs/api-content/api-docs/v1/api.json
diff --git a/docs/deprecated/registries-and-packs/oci-registry.md b/docs/deprecated/registries-and-packs/oci-registry.md
@@ -113,7 +113,7 @@ To provision ECR based OCI Authentication make sure that the User's STS Role has
 ```
 ## Multi-Region Support for AWS ECR registries:
 
-Palette supports the parameterization of AWS ECR registry endpoint to support cross-region replicated registries. For performance considerations, Helm chart content may be replicated across multiple AWS regions and served to the clusters from within the region of cluster deployment. To support this, the variable “{{.spectro.system.aws.region}}” can be used in the registry endpoint. This variable is substituted at the time of cluster deployment with the region selected for deployment. 
+Palette supports the parameterization of AWS ECR registry endpoint to support cross-region replicated registries. For performance considerations, Helm chart content may be replicated across multiple AWS regions and served to the clusters from within the region of cluster deployment. To support this, the variable “\{\{.spectro.system.aws.region}}” can be used in the registry endpoint. This variable is substituted at the time of cluster deployment with the region selected for deployment. 
 
 
 **Region Parameter:**

diff --git a/docs/docs-content/byoos/image-builder.md b/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.

diff --git a/docs/docs-content/clusters/cluster-groups/create-cluster-group.md b/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  |
   |-------------------------------|-----------------|

diff --git a/docs/docs-content/clusters/cluster-groups/ingress-cluster-group.md b/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.
 

diff --git a/docs/docs-content/clusters/cluster-management/image-swap.md b/docs/docs-content/clusters/cluster-management/image-swap.md
@@ -153,7 +153,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 />
 

diff --git a/docs/docs-content/clusters/clusters.md b/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.
-Original file line number
+Diff line change
@@ Expand Up @@
 . Select a Kubernetes distribution and version.
-. 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.
+. 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 />
@@ Expand Down @@