Merge pull request #62 from kube-green/upgrade-docusaurus

upgrade docusaurus
kube-green · Jan 21, 2024 · a0fd039 · a0fd039
2 parents 858c1d5 + 17c1ef2
commit a0fd039
Show file tree

Hide file tree

Showing 7 changed files with 9,661 additions and 18,753 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -5,7 +5,6 @@
     },
     "extends": [
         "plugin:react/recommended",
-        "airbnb",
         "plugin:@typescript-eslint/eslint-recommended",
         "plugin:@typescript-eslint/recommended"
     ],
@@ -19,7 +18,8 @@
     },
     "plugins": [
         "react",
-        "@typescript-eslint"
+        "@typescript-eslint",
+        "import"
     ],
     "ignorePatterns": [
         "*.css",
@@ -36,6 +36,9 @@
                     ".tsx"
                 ]
             }
+        },
+        "react": {
+            "version": "detect"
         }
     },
     "rules": {

diff --git a/docs/install.md b/docs/install.md
@@ -6,7 +6,7 @@ sidebar_position: 3
 
 ## Prerequisite
 
-*kube-green* support all Kubernetes cluster versions >= 1.19 <= 1.28 and OpenShift Container Platform v4.
+*kube-green* support all Kubernetes cluster versions >= 1.19 &lt;= 1.28 and OpenShift Container Platform v4.
 
 Supported architectures are: amd64, arm64.
 

diff --git a/docusaurus.config.js b/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;
 
 const LOGO_IMAGE = 'img/logo.svg';
 const GITHUB_BASE_URL = 'https://github.com/kube-green/kube-green.github.io/'

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -17,34 +17,29 @@
     "lint": "eslint 'src/**/*' 'scripts/**/*.js'"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.4.1",
-    "@docusaurus/preset-classic": "^2.4.1",
-    "@mdx-js/react": "^1.6.21",
-    "@svgr/webpack": "^6.5.1",
-    "clsx": "^1.2.1",
+    "@docusaurus/core": "^3.1.0",
+    "@docusaurus/preset-classic": "^3.1.0",
+    "@mdx-js/react": "^3.0.0",
+    "clsx": "^2.1.0",
     "decimal.js-light": "^2.5.1",
-    "file-loader": "^6.2.0",
-    "prism-react-renderer": "^1.3.5",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
-    "react-player": "^2.12.0",
-    "url-loader": "^4.1.1"
+    "prism-react-renderer": "^2.3.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-player": "^2.14.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.4.1",
-    "@tsconfig/docusaurus": "^1.0.7",
-    "@types/js-yaml": "^4.0.5",
-    "@typescript-eslint/eslint-plugin": "^5.59.8",
-    "@typescript-eslint/parser": "^5.49.0",
-    "cspell": "^7.2.0",
-    "eslint": "^8.42.0",
-    "eslint-config-airbnb": "^19.0.4",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsx-a11y": "^6.7.1",
-    "eslint-plugin-react": "^7.32.2",
+    "@docusaurus/module-type-aliases": "^3.1.0",
+    "@types/js-yaml": "^4.0.9",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
+    "cspell": "^8.3.2",
+    "eslint": "^8.56.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
+    "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "js-yaml": "^4.1.0",
-    "typescript": "^5.1.3"
+    "typescript": "^5.3.3"
   },
   "browserslist": {
     "production": [

diff --git a/scripts/api-reference/config.json b/scripts/api-reference/config.json
@@ -13,7 +13,7 @@
     },
     {
         "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/",
-        "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}"
+        "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}"
     }
   ],
   "typeDisplayNamePrefixOverrides": {

diff --git a/scripts/api-reference/templates/type.tpl b/scripts/api-reference/templates/type.tpl
@@ -2,7 +2,7 @@
 
 <h3 id="{{ anchorIDForType . }}">
     {{- .Name.Name }}
-    {{ if eq .Kind "Alias" }}(<code>{{.Underlying}}</code> alias)</p>{{ end -}}
+    {{- if eq .Kind "Alias" }}(<code>{{.Underlying}}</code> alias)</p>{{ end -}}
 </h3>
 {{ with (typeReferences .) }}
     <p>
@@ -35,7 +35,8 @@
         <tr>
             <td>
                 <code>apiVersion</code><br></br>
-                string</td>
+                string
+            </td>
             <td>
                 <code>
                     {{apiGroup .}}