Bump docusaurus to v3.9 latest

Bumping docosaurus to v3.9 along with adding the following:
* Replace webpack optimizations with experimental_faster package
which works with 3.9 while the webpack is breaking the builds
* Replace latest setup node action with new node version 20 required
by docusaurus builds
* Fix broken escape characters, backslashes `\` break the build
and are replaced with single quotes
* Fix broken imports
* Fix broken configuration and paths

Signed-off-by: Martin Dekov <martin.dekov@suse.com>

Author: martindekov

.github/workflows/pull-request.yml

@@ -17,10 +17,10 @@ jobs:
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
-      - name: Set up Node.js 18
-        uses: actions/setup-node@v4
+      - name: Set up Node.js 20
+        uses: actions/setup-node@v6
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install dependencies
         run: |
@@ -43,10 +43,10 @@ jobs:
       pull-requests: write
     needs: prepare
     steps:
-      - name: Set up Node.js 18
-        uses: actions/setup-node@v4
+      - name: Set up Node.js 20
+        uses: actions/setup-node@v6
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install dependencies
         run: |

.github/workflows/release.yml

@@ -15,10 +15,10 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Set up Node.js 18
-        uses: actions/setup-node@v4
+      - name: Set up Node.js 20
+        uses: actions/setup-node@v6
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install dependencies
         run: |

babel.config.js

@@ -148,7 +148,7 @@ After you obtain a copy of the kubeconfig file, run the following script against
 
   :::note
 
-  You must replace <VIP\> with the [real VIP](../install/management-address.md#how-to-get-the-vip-mac-address), which is the value of `kube-vip.io/requestedIP` in the link.
+  You must replace `<VIP>` with the [real VIP](../install/management-address.md#how-to-get-the-vip-mac-address), which is the value of `kube-vip.io/requestedIP` in the link.
 
   :::
 

docs/troubleshooting/installation.md

@@ -1,17 +1,21 @@
 // @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').DocusaurusConfig} */
 const config = {
   title: "Harvester",
   tagline: "The open-source hyperconverged infrastructure solution for a cloud-native world",
   url: "https://docs.harvesterhci.io",
   baseUrl: "/",
-  onBrokenLinks: "warn",
-  onBrokenMarkdownLinks: "warn",
+  markdown: {
+    hooks: {
+      onBrokenMarkdownLinks: "warn",
+    },
+  },
   favicon: "img/favicon.ico",
   organizationName: "harvester",
   projectName: "docs",
@@ -27,27 +31,9 @@ const config = {
       },
     },
   },
-  webpack: {
-    jsLoader: (isServer) => ({
-      loader: require.resolve("swc-loader"),
-      options: {
-        jsc: {
-          parser: {
-            syntax: "typescript",
-            tsx: true,
-          },
-          target: "es2019",
-          transform: {
-            react: {
-              runtime: "automatic",
-            },
-          },
-        },
-        module: {
-          type: isServer ? "commonjs" : "es6",
-        },
-      },
-    }),
+  future: {
+    v4: true,
+    experimental_faster: true,
   },
   themes: ["docusaurus-theme-openapi-docs"],
   presets: [

docusaurus.config.js

@@ -20,20 +20,21 @@
     "gen-pdf-docs": "docs-to-pdf docusaurus --initialDocURLs='http://localhost:3000' --contentSelector='article' --paginationSelector='a.pagination-nav__link.pagination-nav__link--next' --excludeSelectors='.margin-vert--xl a,[class^='tocCollapsible'],.breadcrumbs,.theme-edit-this-page' --excludePaths='/v1.3/api/' --protocolTimeout=360000 --outputPDFFilename=harvester.pdf"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.4.0",
-    "@docusaurus/plugin-client-redirects": "^2.4.0",
-    "@docusaurus/plugin-content-blog": "^2.4.0",
-    "@docusaurus/plugin-content-docs": "^2.4.0",
-    "@docusaurus/plugin-content-pages": "^2.4.0",
-    "@docusaurus/plugin-debug": "^2.4.0",
-    "@docusaurus/preset-classic": "^2.4.0",
-    "@mdx-js/react": "^1.6.22",
+    "@docusaurus/core": "^3.9.0",
+    "@docusaurus/faster": "^3.9.0",
+    "@docusaurus/plugin-client-redirects": "^3.9.0",
+    "@docusaurus/plugin-content-blog": "^3.9.0",
+    "@docusaurus/plugin-content-docs": "^3.9.0",
+    "@docusaurus/plugin-content-pages": "^3.9.0",
+    "@docusaurus/plugin-debug": "^3.9.0",
+    "@docusaurus/preset-classic": "^3.9.0",
+    "@mdx-js/react": "^3.0.0",
     "clsx": "^1.1.1",
     "docs-to-pdf": "^0.6.2",
-    "docusaurus-plugin-image-zoom": "^1.0.0",
-    "docusaurus-plugin-openapi-docs": "^2.1.2",
-    "docusaurus-theme-openapi-docs": "^2.1.2",
-    "prism-react-renderer": "^1.3.1",
+    "docusaurus-plugin-image-zoom": "^3.0.1",
+    "docusaurus-plugin-openapi-docs": "^4.5.1",
+    "docusaurus-theme-openapi-docs": "^4.5.1",
+    "prism-react-renderer": "^2.4.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "remark-cli": "^11.0.0",

package.json

@@ -11,6 +11,8 @@
 
 // @ts-check
 
+const apiSidebar = require("./docs/api/sidebar.ts");
+
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
   docs: [{ type: 'autogenerated', dirName: '.' }],
@@ -24,7 +26,7 @@ const sidebars = {
         description:
           "This is the API doc of the Harvester server. The APIs are broken down into the categories below:",
       },
-      items: require("./docs/api/sidebar.js"),
+      items: apiSidebar.default || apiSidebar,
     },
   ],
 };

sidebars.js

@@ -7,12 +7,10 @@ import Translate from '@docusaurus/Translate';
 import {
   useActivePlugin,
   useDocVersionSuggestions,
+  useDocsVersion,
+  useDocsPreferredVersion,
 } from '@docusaurus/plugin-content-docs/client';
 import {ThemeClassNames} from '@docusaurus/theme-common';
-import {
-  useDocsPreferredVersion,
-  useDocsVersion,
-} from '@docusaurus/theme-common/internal';
 function UnreleasedVersionLabel({siteTitle, versionMetadata}) {
   return (
     <Translate

src/theme/DocVersionBanner/index.js

@@ -148,7 +148,7 @@ After you obtain a copy of the kubeconfig file, run the following script against
 
   :::note
 
-  You must replace <VIP\> with the [real VIP](../install/management-address.md#how-to-get-the-vip-mac-address), which is the value of `kube-vip.io/requestedIP` in the link.
+  You must replace `<VIP>` with the [real VIP](../install/management-address.md#how-to-get-the-vip-mac-address), which is the value of `kube-vip.io/requestedIP` in the link.
 
   :::
 

versioned_docs/version-v1.4/troubleshooting/installation.md

@@ -146,7 +146,7 @@ After you obtain a copy of the kubeconfig file, run the following script against
 
   :::note
 
-  You must replace <VIP\> with the [real VIP](../install/management-address.md#how-to-get-the-vip-mac-address), which is the value of `kube-vip.io/requestedIP` in the link.
+  You must replace `<VIP>` with the [real VIP](../install/management-address.md#how-to-get-the-vip-mac-address), which is the value of `kube-vip.io/requestedIP` in the link.
 
   :::