WIP: Embedded Cluster v3

docusaurus.config.js

@@ -7,7 +7,7 @@ const darkTheme = themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: 'Replicated Docs',
+  title: 'Replicated',
   tagline: 'Technical documentation for Replicated vendors and their enterprise end-customers.',
   url: 'https://docs.replicated.com',
   baseUrl: '/',
@@ -29,7 +29,7 @@ const config = {
         docs: {
           routeBasePath: '/', // Serve the docs at the site's root
           sidebarPath: require.resolve('./sidebars.js'),
-          breadcrumbs: false,
+          breadcrumbs: true,
           editUrl: 'https://github.com/replicatedhq/replicated-docs/edit/main/',
           admonitions: {
             keywords: ['note','important', 'tip', 'info', 'caution', 'danger'],
@@ -50,7 +50,36 @@ const config = {
       }),
     ],
   ],
-
+  plugins: [
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'installer',
+        path: 'installer',
+        routeBasePath: 'installer',
+        sidebarPath: './sidebarInstaller.js',
+        breadcrumbs: true,
+        editUrl: 'https://github.com/replicatedhq/replicated-docs/edit/main/',
+        // Versioning configuration
+        lastVersion: 'current', // Make 3.0.0 the default version
+        includeCurrentVersion: true, // Include the "next" version from installer/ folder
+        versions: {
+          current: {
+            label: 'Embedded Cluster 3.0.0',
+            path: 'v3',
+            banner: 'none',
+            badge: false,
+          },
+          '2.0.0': {
+            label: 'Embedded Cluster 2.13.3',
+            path: 'v2',
+            banner: 'unmaintained',
+            badge: false,
+          },
+        },
+      },
+    ],
+  ],
   scripts: [
     {
       src:
@@ -136,7 +165,8 @@ const config = {
               },
               {
                 type: 'doc',
-                docId: 'vendor/embedded-overview',
+                docId: 'v3-placeholder',
+                docsPluginId: 'installer',
                 label: 'Embedded Cluster',
               },
               {
@@ -173,9 +203,19 @@ const config = {
           },
           {
             type: 'dropdown',
-            label: 'Developer tools',
+            label: 'Reference',
             position: 'left',
             items: [
+              {
+                type: 'doc',
+                docId: 'reference/custom-resource-about',
+                label: 'Custom resources',
+              },
+              {
+                type: 'doc',
+                docId: 'reference/template-functions-about',
+                label: 'Template functions',
+              },
               {
                 type: 'doc',
                 docId: 'reference/kots-cli-getting-started',

installer/v3-placeholder.md

@@ -0,0 +1 @@
+# v3 placeholder

docs/reference/embedded-cluster-install.mdx → installer_versioned_docs/version-2.0.0/embedded-cluster-install.mdx

@@ -1,7 +1,7 @@
-import ProxyLimitations from "../partials/embedded-cluster/_proxy-install-limitations.mdx"
-import ProxyRequirements from "../partials/embedded-cluster/_proxy-install-reqs.mdx"
-import ProxyEnvVars from "../partials/embedded-cluster/_proxy-env-vars.mdx"
-import DeprecatedPrivateCa from "../partials/embedded-cluster/_deprecated-private-ca.mdx"
+import ProxyLimitations from "../../docs/partials/embedded-cluster/_proxy-install-limitations.mdx"
+import ProxyRequirements from "../../docs/partials/embedded-cluster/_proxy-install-reqs.mdx"
+import ProxyEnvVars from "../../docs/partials/embedded-cluster/_proxy-env-vars.mdx"
+import DeprecatedPrivateCa from "../../docs/partials/embedded-cluster/_deprecated-private-ca.mdx"
 
 # install
 

docs/reference/embedded-config.mdx → installer_versioned_docs/version-2.0.0/embedded-config.mdx

@@ -1,4 +1,4 @@
-import DoNotDowngrade from "../partials/embedded-cluster/_warning-do-not-downgrade.mdx"
+import DoNotDowngrade from "../../docs/partials/embedded-cluster/_warning-do-not-downgrade.mdx"
 
 # Embedded Cluster Config
 

docs/enterprise/embedded-manage-nodes.mdx → installer_versioned_docs/version-2.0.0/embedded-manage-nodes.mdx

@@ -1,5 +1,5 @@
-import HaArchitecture from "../partials/embedded-cluster/_multi-node-ha-arch.mdx"
-import ShellCommand from "../partials/embedded-cluster/_shell-command.mdx"
+import HaArchitecture from "../../docs/partials/embedded-cluster/_multi-node-ha-arch.mdx"
+import ShellCommand from "../../docs/partials/embedded-cluster/_shell-command.mdx"
 
 # Access and manage embedded clusters
 

docs/vendor/embedded-overview.mdx → installer_versioned_docs/version-2.0.0/embedded-overview.mdx

@@ -1,5 +1,5 @@
-import EmbeddedCluster from "../partials/embedded-cluster/_definition.mdx"
-import HaArchitecture from "../partials/embedded-cluster/_multi-node-ha-arch.mdx"
+import EmbeddedCluster from "../../docs/partials/embedded-cluster/_definition.mdx"
+import HaArchitecture from "../../docs/partials/embedded-cluster/_multi-node-ha-arch.mdx"
 
 # Embedded Cluster overview
 

docs/vendor/embedded-troubleshooting.mdx → installer_versioned_docs/version-2.0.0/embedded-troubleshooting.mdx

@@ -1,6 +1,6 @@
-import SupportBundleIntro from "../partials/support-bundles/_ec-support-bundle-intro.mdx"
-import EmbeddedClusterSupportBundle from "../partials/support-bundles/_generate-bundle-ec.mdx"
-import ShellCommand from "../partials/embedded-cluster/_shell-command.mdx"
+import SupportBundleIntro from "../../docs/partials/support-bundles/_ec-support-bundle-intro.mdx"
+import EmbeddedClusterSupportBundle from "../../docs/partials/support-bundles/_generate-bundle-ec.mdx"
+import ShellCommand from "../../docs/partials/embedded-cluster/_shell-command.mdx"
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 

docs/vendor/embedded-using.mdx → installer_versioned_docs/version-2.0.0/embedded-using.mdx

@@ -1,6 +1,6 @@
-import UpdateOverview from "../partials/embedded-cluster/_update-overview.mdx"
-import EcConfig from "../partials/embedded-cluster/_ec-config.mdx"
-import ShellCommand from "../partials/embedded-cluster/_shell-command.mdx"
+import UpdateOverview from "../../docs/partials/embedded-cluster/_update-overview.mdx"
+import EcConfig from "../../docs/partials/embedded-cluster/_ec-config.mdx"
+import ShellCommand from "../../docs/partials/embedded-cluster/_shell-command.mdx"
 
 # Configure Embedded Cluster
 

docs/enterprise/installing-embedded-air-gap.mdx → installer_versioned_docs/version-2.0.0/installing-embedded-air-gap.mdx

@@ -1,8 +1,8 @@
-import UpdateAirGapAdm from "../partials/embedded-cluster/_update-air-gap-admin-console.mdx"
-import UpdateAirGapCli from "../partials/embedded-cluster/_update-air-gap-cli.mdx"
-import UpdateAirGapOverview from "../partials/embedded-cluster/_update-air-gap-overview.mdx"
-import DoNotDowngrade from "../partials/embedded-cluster/_warning-do-not-downgrade.mdx"
-import Prerequisites from "../partials/install/_ec-prereqs.mdx"
+import UpdateAirGapAdm from "../../docs/partials/embedded-cluster/_update-air-gap-admin-console.mdx"
+import UpdateAirGapCli from "../../docs/partials/embedded-cluster/_update-air-gap-cli.mdx"
+import UpdateAirGapOverview from "../../docs/partials/embedded-cluster/_update-air-gap-overview.mdx"
+import DoNotDowngrade from "../../docs/partials/embedded-cluster/_warning-do-not-downgrade.mdx"
+import Prerequisites from "../../docs/partials/install/_ec-prereqs.mdx"
 
 # Air gap installation with Embedded Cluster
 

docs/enterprise/installing-embedded-automation.mdx → installer_versioned_docs/version-2.0.0/installing-embedded-automation.mdx

@@ -1,6 +1,6 @@
-import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx"
-import ConfigValuesProcedure from "../partials/configValues/_config-values-procedure.mdx"
-import ConfigValuesRequirements from "../partials/configValues/_requirements.mdx"
+import ConfigValuesExample from "../../docs/partials/configValues/_configValuesExample.mdx"
+import ConfigValuesProcedure from "../../docs/partials/configValues/_config-values-procedure.mdx"
+import ConfigValuesRequirements from "../../docs/partials/configValues/_requirements.mdx"
 
 # Automate installation with Embedded Cluster
 

docs/enterprise/installing-embedded-requirements.mdx → installer_versioned_docs/version-2.0.0/installing-embedded-requirements.mdx

@@ -1,7 +1,7 @@
-import EmbeddedClusterRequirements from "../partials/embedded-cluster/_requirements.mdx"
-import EmbeddedClusterPortRequirements from "../partials/embedded-cluster/_port-reqs.mdx"
-import FirewallOpeningsIntro from "../partials/install/_firewall-openings-intro.mdx"
-import FirewallOpeningsEc from "../partials/install/_firewall-openings-embedded-cluster.mdx"
+import EmbeddedClusterRequirements from "../../docs/partials/embedded-cluster/_requirements.mdx"
+import EmbeddedClusterPortRequirements from "../../docs/partials/embedded-cluster/_port-reqs.mdx"
+import FirewallOpeningsIntro from "../../docs/partials/install/_firewall-openings-intro.mdx"
+import FirewallOpeningsEc from "../../docs/partials/install/_firewall-openings-embedded-cluster.mdx"
 
 # Embedded Cluster installation requirements
 

docs/enterprise/installing-embedded.mdx → installer_versioned_docs/version-2.0.0/installing-embedded.mdx

@@ -1,4 +1,4 @@
-import Prerequisites from "../partials/install/_ec-prereqs.mdx"
+import Prerequisites from "../../docs/partials/install/_ec-prereqs.mdx"
 
 # Online installation with Embedded Cluster
 

docs/enterprise/updating-embedded.mdx → installer_versioned_docs/version-2.0.0/updating-embedded.mdx

@@ -1,8 +1,8 @@
-import UpdateAirGapAdm from "../partials/embedded-cluster/_update-air-gap-admin-console.mdx"
-import UpdateAirGapCli from "../partials/embedded-cluster/_update-air-gap-cli.mdx"
-import UpdateAirGapOverview from "../partials/embedded-cluster/_update-air-gap-overview.mdx"
-import DoNotDowngrade from "../partials/embedded-cluster/_warning-do-not-downgrade.mdx"
-import Overview from "../partials/embedded-cluster/_update-overview.mdx"
+import UpdateAirGapAdm from "../../docs/partials/embedded-cluster/_update-air-gap-admin-console.mdx"
+import UpdateAirGapCli from "../../docs/partials/embedded-cluster/_update-air-gap-cli.mdx"
+import UpdateAirGapOverview from "../../docs/partials/embedded-cluster/_update-air-gap-overview.mdx"
+import DoNotDowngrade from "../../docs/partials/embedded-cluster/_warning-do-not-downgrade.mdx"
+import Overview from "../../docs/partials/embedded-cluster/_update-overview.mdx"
 
 # Perform updates in embedded clusters
 

installer_versioned_sidebars/version-2.0.0-sidebars.json

@@ -0,0 +1,40 @@
+{
+  "installerSidebar": [
+    "embedded-overview",
+    "embedded-using",
+    "embedded-config",
+    {
+      "type": "category",
+      "label": "Install with Embedded Cluster",
+      "items": [
+        "installing-embedded-requirements",
+        "installing-embedded",
+        "installing-embedded-air-gap",
+        "installing-embedded-automation"
+      ]
+    },
+    "embedded-manage-nodes",
+    "updating-embedded",
+    "embedded-troubleshooting",
+    "embedded-tls-certs",
+    "embedded-disaster-recovery",
+    {
+      "type": "category",
+      "label": "Embedded Cluster Commands",
+      "items": [
+        "embedded-cluster-admin-console",
+        "embedded-cluster-completion",
+        "embedded-cluster-enable-ha",
+        "embedded-cluster-install",
+        "embedded-cluster-join",
+        "embedded-cluster-join-print-command",
+        "embedded-cluster-reset",
+        "embedded-cluster-restore",
+        "embedded-cluster-shell",
+        "embedded-cluster-support-bundle",
+        "embedded-cluster-update",
+        "embedded-cluster-version"
+      ]
+    }
+  ]
+}

installer_versions.json

@@ -0,0 +1,3 @@
+[
+  "2.0.0"
+]

sidebarCompatibilityMatrix.js

@@ -0,0 +1,22 @@
+// sidebar heading is set in src/utils/sidebarProductFromPath.js in SIDEBAR_CONFIG
+
+module.exports = {
+  compatibilityMatrixSidebar: [
+    "vendor/testing-about",
+    "vendor/testing-supported-clusters",
+    "vendor/testing-how-to",
+    "vendor/testing-vm-create",
+    "vendor/testing-ingress",
+    "vendor/testing-network-policy",
+    "vendor/testing-cluster-addons",
+    "vendor/testing-ci-cd",
+    {
+      type: "category",
+      label: "Manage cost and usage",
+      items: [
+        "vendor/testing-pricing",
+        "vendor/compatibility-matrix-usage",
+      ],
+    },
+  ],
+};

sidebarEnterprisePortal.js

@@ -0,0 +1,12 @@
+// sidebar heading is set in src/utils/sidebarProductFromPath.js in SIDEBAR_CONFIG
+
+module.exports = {
+  enterprisePortalSidebar: [
+    "vendor/enterprise-portal-about",
+    "vendor/enterprise-portal-configure",
+    "vendor/enterprise-portal-invite",
+    "vendor/enterprise-portal-self-serve-signup",
+    "vendor/enterprise-portal-access",
+    "vendor/enterprise-portal-use",
+  ],
+};

sidebarHelm.js

@@ -0,0 +1,11 @@
+// sidebar heading is set in src/utils/sidebarProductFromPath.js in SIDEBAR_CONFIG
+module.exports = {
+    helmSidebar: [
+      "vendor/helm-install-overview",
+      "vendor/helm-install-values-schema",
+      "vendor/install-with-helm",
+      "vendor/helm-install-airgap",
+      "vendor/using-third-party-registry-proxy",
+      "vendor/helm-install-troubleshooting",
+    ],
+  };

sidebarInstaller.js

@@ -0,0 +1,6 @@
+// sidebar heading is set in src/utils/sidebarProductFromPath.js in SIDEBAR_CONFIG
+module.exports = {
+  installerSidebar: [
+    "v3-placeholder",
+  ],
+};