Fix incompatibilities between docusaurus 2 to 3

Fix generators, for example only 6 #'s are allowed now.

Signed-off-by: Ryan Swanson <ryan.swanson@loft.sh>

Author: zerbitx

devspace-schema.json

@@ -452,7 +452,7 @@
       "properties": {
         "command": {
           "type": "string",
-          "description": "Command to execute to build the image. You can use ${runtime.images.my-image.image} and ${runtime.image.my-image.tag}\nto reference the image and tag that should get built."
+          "description": "Command to execute to build the image. You can use `${runtime.images.my-image.image}` and `${runtime.images.my-image.tag}`\nto reference the image and tag that should get built."
         },
         "onChange": {
           "oneOf": [
@@ -3513,7 +3513,7 @@
         },
         "initialSync": {
           "type": "string",
-          "description": "InitialSync defines the initial sync strategy to use when this sync starts. Defaults to mirrorLocal",
+          "description": "InitialSync defines the initial sync strategy to use when this sync starts. Defaults to mirrorLocal.\nYou can completely disable this using the `initialSync: disabled` option.",
           "group": "initial_sync",
           "group_name": "Initial Sync"
         },

docs/.nvmrc

@@ -1 +1 @@
-18.16
+20

docs/docusaurus.config.js

@@ -7,6 +7,11 @@ module.exports = {
   tagline: 'The tagline of my site',
   url: 'https://devspace.sh',
   baseUrl: __webpack_public_path__,
+  markdown: {
+    mdx1Compat: {
+      headingIds: true,
+    },
+  },
   favicon: '/img/favicon.png',
   organizationName: 'loft-sh', // Usually your GitHub org/user name.
   projectName: 'devspace', // Usually your repo name.
@@ -84,39 +89,6 @@ module.exports = {
                   path: ""
               }
           },
-          remarkPlugins: [
-              [
-                  require('mdx-mermaid'),
-                  {
-                      mermaid: {
-                          securityLevel: "loose",
-                          theme: 'neutral',
-                          themeVariables: {
-                              primaryColor: '#00bdff',
-                              lineColor: '#bdd6f3',
-                              arrowheadColor: '#bdd6f3',
-                              mainBkg: '#6c89ad',
-                              contrast: '#3e5371',
-                              textColor: '#fff',
-                              primaryTextColor: '#fff',
-                              secondaryTextColor: '#fff',
-                              tertiaryTextColor: '#fff',
-                              border1: 'transparent',
-                              border2: 'transparent',
-                              clusterBkg: 'transparent',
-                              clusterBorder: '#bdd6f3',
-                              edgeLabelBackground: '#bcd6f3',
-
-                          },
-                          flowchart: {
-                              curve: 'basis',
-                              nodeSpacing: 20,
-                              rankSpacing: 50,
-                          }
-                      }
-                  }
-              ]
-          ],
       },
         theme: {
           customCss: resolveGlob.sync(['./src/css/**/*.scss']),

docs/hack/util/schema.go

@@ -75,7 +75,7 @@ func GenerateReference(schema *jsonschema.Schema, basePath string) {
 func createSections(basePath, prefix string, schema *jsonschema.Schema, definitions jsonschema.Definitions, depth int, parentIsNameObjectMap bool) string {
 	partialImports := &[]string{}
 	content := ""
-	headlinePrefix := strings.Repeat("#", depth+1) + " "
+	headlinePrefix := headingPrefix(depth)
 	anchorPrefix := strings.TrimPrefix(strings.ReplaceAll(prefix, prefixSeparator, anchorSeparator), anchorSeparator)
 
 	groups := map[string]*Group{}
@@ -277,6 +277,14 @@ func createSections(basePath, prefix string, schema *jsonschema.Schema, definiti
 	return content
 }
 
+func headingPrefix(depth int) string {
+	headingLevel := depth + 1
+	if headingLevel > 6 {
+		headingLevel = 6
+	}
+	return strings.Repeat("#", headingLevel) + " "
+}
+
 func GetEumValues(fieldSchema *jsonschema.Schema, required bool, fieldDefault *string) string {
 	enumValues := ""
 	if fieldSchema.Enum != nil {

docs/hack/util/schema_test.go

@@ -0,0 +1,23 @@
+package util
+
+import "testing"
+
+func TestHeadingPrefixCapsAtLevelSix(t *testing.T) {
+	testCases := []struct {
+		name     string
+		depth    int
+		expected string
+	}{
+		{name: "top level", depth: 1, expected: "## "},
+		{name: "sixth level", depth: 5, expected: "###### "},
+		{name: "deeper than six", depth: 8, expected: "###### "},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.name, func(t *testing.T) {
+			if actual := headingPrefix(testCase.depth); actual != testCase.expected {
+				t.Fatalf("headingPrefix(%d) = %q, want %q", testCase.depth, actual, testCase.expected)
+			}
+		})
+	}
+}

docs/package.json

@@ -2,6 +2,9 @@
   "name": "devspace-cloud",
   "version": "0.0.0",
   "private": true,
+  "engines": {
+    "node": ">=20.0"
+  },
   "scripts": {
     "start": "docusaurus start",
     "build": "docusaurus build",
@@ -15,11 +18,9 @@
     "classnames": "^2.2.6",
     "docusaurus-plugin-sass": "^0.2.6",
     "mdx-link-checker": "^0.1.1",
-    "mdx-mermaid": "^v1.3.0",
-    "mermaid": "^11.12.3",
     "plugin-image-zoom": "ataft/plugin-image-zoom",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "redocusaurus": "^2.1.1",
     "resolve-glob": "^1.0.0",
     "sass": "^1.93.2"

docs/pages/_partials/workflow-replace-tags.mdx

@@ -8,6 +8,5 @@ Replacing or appending tags to images that are used in your deployments makes su
 
 DevSpace will replace the following things:
 - **registry.url/repo/name** that corresponds to a `images.*.image`, will be rewritten to `registry.url/repo/name:generated_tag`
-- **${runtime.images.image-key.image}** that corresponds to a `images.*` key, will be rewritten to `registry.url/repo/name`. You can also use dependency images here with `${runtime.dependencies.dep1.images.dep-image.image}`
-- **${runtime.images.image-key.tag}** that corresponds to a `images.*` key, will be rewritten to `generated_tag`. You can also use dependency images here with `${runtime.dependencies.dep1.images.dep-image.tag}`
-
+- **`${runtime.images.image-key.image}`** that corresponds to a `images.*` key, will be rewritten to `registry.url/repo/name`. You can also use dependency images here with `${runtime.dependencies.dep1.images.dep-image.image}`
+- **`${runtime.images.image-key.tag}`** that corresponds to a `images.*` key, will be rewritten to `generated_tag`. You can also use dependency images here with `${runtime.dependencies.dep1.images.dep-image.tag}`

docs/pages/configuration/_partials/v2beta1/dev/containers/persistPaths/initContainer/resources/limits.mdx

@@ -2,7 +2,7 @@
 <details className="config-field" data-expandable="false" open>
 <summary>
 
-####### `limits` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">&lt;limit_name&gt;:string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-persistPaths-initContainer-resources-limits}
+###### `limits` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">&lt;limit_name&gt;:string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-persistPaths-initContainer-resources-limits}
 
 Limits are the limits part of the resources
 

docs/pages/configuration/_partials/v2beta1/dev/containers/persistPaths/initContainer/resources/requests.mdx

@@ -2,7 +2,7 @@
 <details className="config-field" data-expandable="false" open>
 <summary>
 
-####### `requests` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">&lt;request_name&gt;:string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-persistPaths-initContainer-resources-requests}
+###### `requests` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">&lt;request_name&gt;:string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-persistPaths-initContainer-resources-requests}
 
 Requests are the requests part of the resources
 

docs/pages/configuration/_partials/v2beta1/dev/containers/sync/initialSync.mdx

@@ -4,7 +4,7 @@
 
 ##### `initialSync` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-sync-initialSync}
 
-InitialSync defines the initial sync strategy to use when this sync starts. Defaults to mirrorLocal
+InitialSync defines the initial sync strategy to use when this sync starts. Defaults to mirrorLocal.
 You can completely disable this using the `initialSync: disabled` option.
 
 </summary>