feat: docusaurus v3.4.0 and asset updates.

appvia · Aug 13, 2024 · 6f4f6d0 · 6f4f6d0
1 parent c9ef5e2
commit 6f4f6d0
Show file tree

Hide file tree

Showing 47 changed files with 10,896 additions and 16,921 deletions.
diff --git a/docs/terranetes-controller/admin/providers.md b/docs/terranetes-controller/admin/providers.md
@@ -211,7 +211,7 @@ spec:
 :::caution
 Details on binding can be found [here](https://azure.github.io/aad-pod-identity/docs/concepts/azureidentitybinding/), but essentially it's used to filter the pods in the namespace and provide the permissions to the pods that match the labels - i.e. the pod must have label of the same name and value.
 
-As of <= v0.3.30 the pod selector is not configurable in the controller to ensure you use `terranetes-executor` on the binding.
+As of \<= v0.3.30 the pod selector is not configurable in the controller to ensure you use `terranetes-executor` on the binding.
 :::
 
 #### Service Account Permissions

diff --git a/docs/terranetes-controller/cli/tnctl_completion_bash.md b/docs/terranetes-controller/cli/tnctl_completion_bash.md
@@ -14,7 +14,7 @@ If it is not installed already, you can install it via your OS's package manager
 
 To load completions in your current shell session:
 
-	source <(tnctl completion bash)
+	source \<(tnctl completion bash)
 
 To load completions for every new session, execute once:
 

diff --git a/docs/terranetes-controller/cli/tnctl_completion_zsh.md b/docs/terranetes-controller/cli/tnctl_completion_zsh.md
@@ -16,13 +16,13 @@ to enable it.  You can execute the following once:
 
 To load completions in your current shell session:
 
-	source <(tnctl completion zsh)
+	source \<(tnctl completion zsh)
 
 To load completions for every new session, execute once:
 
 #### Linux:
 
-	tnctl completion zsh > "${fpath[1]}/_tnctl"
+	tnctl completion zsh > "$\{fpath[1]}/_tnctl"
 
 #### macOS:
 

diff --git a/docs/terranetes-controller/cli/tnctl_create_workflow.md b/docs/terranetes-controller/cli/tnctl_create_workflow.md
@@ -22,7 +22,7 @@ Generate a workflow for module
 $ tnctl create workflow PATH
 
 You can override the location of the template via the configuration
-file ${HOME}/.tnctl/config.yaml (or TNCTL_CONFIG). Just add the
+file $\{HOME}/.tnctl/config.yaml (or TNCTL_CONFIG). Just add the
 following
 
 ---

diff --git a/docs/terranetes-controller/cli/tnctl_kubectl_plugin.md b/docs/terranetes-controller/cli/tnctl_kubectl_plugin.md
@@ -14,11 +14,11 @@ called from kubectl. You need to ensure the scripts this command
 generates are included your $PATH, long with the location of the
 tnctl command.
 
-Create the kubectl plugins (defaults to ${HOME}/bin)
+Create the kubectl plugins (defaults to $\{HOME}/bin)
 $ tnctl kubectl plugin
 
 Place the plugins scripts in another directory
-$ tnctl kubectl plugin -d ${GOPATH}/bin
+$ tnctl kubectl plugin -d $\{GOPATH}/bin
 
 
 ```

diff --git a/docs/terranetes-controller/cli/tnctl_workflow_create.md b/docs/terranetes-controller/cli/tnctl_workflow_create.md
@@ -16,7 +16,7 @@ Generate a workflow for module
 $ tnctl workflow create PATH
 
 You can override the location of the template via the configuration
-file ${HOME}/.tnctl/config.yaml (or TNCTL_CONFIG). Just add the
+file $\{HOME}/.tnctl/config.yaml (or TNCTL_CONFIG). Just add the
 following
 
 ---

diff --git a/docusaurus.config.js b/docusaurus.config.js
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -0,0 +1,172 @@
+// @ts-check
+// Note: type annotations allow type checking and IDEs autocompletion
+
+import type {Config} from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
+
+const lightCodeTheme = require('prism-react-renderer').themes.github;
+const darkCodeTheme = require('prism-react-renderer').themes.dracula;
+
+const config: Config = {
+  title: 'Appvia Terranetes Controller',
+  tagline:
+    'Enable teams to self-serve cloud and application dependencies easily and securely',
+  url: 'https://terranetes.appvia.io',
+  baseUrl: '/',
+  trailingSlash: true,
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+  favicon: 'img/favicon-docs.svg',
+  organizationName: 'appvia',
+  projectName: 'terranetes',
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  themeConfig: {
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    navbar: {
+      title: '',
+      logo: {
+        alt: 'Terranetes Logo',
+        src: '/img/index/terranetes-light.svg',
+        srcDark: '/img/index/terranetes-dark.svg',
+        href: '/',
+      },
+      items: [
+        {
+          href: 'https://github.com/appvia/terranetes-controller',
+          label: 'GitHub',
+          position: 'right',
+        },
+      ],
+    },
+    footer: {
+      style: 'light',
+      links: [
+        {
+          title: 'Products',
+          items: [
+            {
+              label: 'Terranetes Controller',
+              href: 'https://www.appvia.io/terranetes',
+            },
+            {
+              label: 'Wayfinder',
+              href: 'https://www.appvia.io/wayfinder',
+            },
+            {
+              label: 'Tako',
+              href: 'https://www.appvia.io/tako',
+            },
+            {
+              label: 'Krane',
+              href: 'https://github.com/appvia/krane',
+            },
+          ],
+        },
+        {
+          title: 'Community',
+          items: [
+            {
+              label: 'Kubernetes Slack',
+              href: 'https://kubernetes.slack.com/channels/terranetes',
+            },
+            {
+              label: 'Twitter',
+              href: 'https://twitter.com/appvia_io',
+            },
+          ],
+        },
+        {
+          title: 'More',
+          items: [
+            {
+              label: 'GitHub',
+              href: 'https://github.com/appvia',
+            },
+            {
+              label: 'Blog',
+              href: 'https://www.appvia.io/blog',
+            },
+            {
+              label: 'YouTube',
+              href: 'https://www.youtube.com/@appvia',
+            },
+          ],
+        },
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} Appvia Ltd. All rights reserved.`,
+    },
+    prism: {
+      additionalLanguages: ['powershell', 'hcl'],
+      darkTheme: darkCodeTheme,
+      theme: lightCodeTheme,
+    },
+  },
+
+  presets: [
+    [
+      "classic",
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        blog: {},
+        docs: {
+          id: 'terranetes-controller',
+          path: 'docs/terranetes-controller',
+          routeBasePath: 'terranetes-controller',
+          sidebarPath: require.resolve('./sidebars-terranetes-controller.ts'),
+          editUrl: 'https://github.com/appvia/terranetes/tree/master/',
+          editCurrentVersion: true,
+          showLastUpdateAuthor: true,
+          showLastUpdateTime: true,
+          breadcrumbs: true,
+        },
+        googleAnalytics: {
+          trackingID: 'UA-120919526-1',
+        },
+        gtag: {
+          trackingID: 'UA-120919526-1',
+        },
+        theme: {
+          customCss: require.resolve('./src/css/custom.css'),
+        },
+      }),
+    ],
+  ],
+  plugins: [
+    [
+      require.resolve('@easyops-cn/docusaurus-search-local'),
+      {
+        hashed: true,
+        indexDocs: true,
+        indexBlog: false,
+        docsPluginIdForPreferredVersion: "terranetes-controller",
+        docsRouteBasePath: "terranetes-controller"
+      }
+    ],
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'tf2helm',
+        path: 'docs/tf2helm',
+        routeBasePath: 'tf2helm',
+        sidebarPath: require.resolve('./sidebars-tf2helm.ts'),
+        editUrl: 'https://github.com/appvia/terranetes/tree/master/',
+        editCurrentVersion: true,
+        showLastUpdateAuthor: true,
+        showLastUpdateTime: true,
+        breadcrumbs: true,
+      },
+    ],
+  ],
+  stylesheets: [
+    {
+      href: "https://use.fontawesome.com/releases/v5.11.0/css/all.css",
+      type: "text/css",
+    },
+  ],  
+};
+
+export default config;