chore: Update docusaurus to v3 (#166)

* Fix errors found by docusaurus-mdx-checker * Update dependencies * Update config * Fix npm audit errros. * Fix links in docs. * update readme. * Update docusaurus and related deps to version 3.0.1 --------- Signed-off-by: Mirjam Aulbach <[email protected]>
Aiven-Open · Dec 1, 2023 · 60020b5 · 60020b5
1 parent 74e0eaa
commit 60020b5
Show file tree

Hide file tree

Showing 24 changed files with 4,055 additions and 2,377 deletions.
diff --git a/README.md b/README.md
@@ -40,12 +40,14 @@ The, install all needed dependencies and setup the needed githooks:
 npm install
 ```
 
-To start local the local development server, run:
+To start the local development server, run:
 
 ```shell
 npm start
 ```
 
+🦖 the website will now run on `http://localhost:3000/`
+
 ## Scripts used and their actions
 
 ℹ️ You can see all our scripts in the [`package.json`](package.json).

diff --git a/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md b/docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md
@@ -16,10 +16,10 @@ References:
 
 [//]: # "<!-- markdown-link-check-disable -->"
 
-- <https://docs.confluent.io/cloud/current/api.html#tag/Topic-(v3)>
-- <https://docs.confluent.io/cloud/current/api.html#tag/ACL-(v3)>
+- [Confluent documentation Topic(v3)](<https://docs.confluent.io/cloud/current/api.html#tag/Topic-(v3)>)
+- [Confluent documentation ACL(v3)](<https://docs.confluent.io/cloud/current/api.html#tag/ACL-(v3)>)
 
-[//]: # "<!-- markdown-link-check-enable -->"
+[//]: # "<!-Topic (v3)- markdown-link-check-enable -->"
 
 ## Prerequisite
 
@@ -43,7 +43,7 @@ Follow the steps below to configure and connect to a Confluent Cloud Kafka and K
    - **Cluster Name:** Provide a name for the cluster
    - **Protocol:** Select SSL protocol for your cluster
    - **Kafka Flavor:** Select Confluent Cloud Kafka as the flavor
-   - **Bootstrap server:** Enter the REST endpoint of your Confluent Cloud Kafka cluster (without <https://>). Ex:
+   - **Bootstrap server:** Enter the REST endpoint of your Confluent Cloud Kafka cluster (without `https://`). Ex:
      `xyz-pk07es.us-west4.gcp.confluent.cloud:443`
 
 4. Click **Save**.
@@ -69,8 +69,7 @@ Follow the steps below to configure and connect to a Confluent Cloud Kafka and K
     dev3.klaw.clusters.counfluentcloud.acls.api=/kafka/v3/clusters/abc-ab1abc/acls
     ```
 
-    - Copy the {cluster_id} from the Confluent Cloud portal (Cluster Settings > General > Identification > Cluster ID)
-      and insert into the API URI.
+    - Copy the `{cluster_id}` from the Confluent Cloud portal (Cluster Settings > General > Identification > Cluster ID) and insert into the API URI.
     - Copy the API key/secrets from Confluent Cloud > API Keys.
     - For the lines starting with `clusterid`, replace `clusterid` with the Klaw Cluster ID. Save
       the `application.properties` file.

diff --git a/docs/HowTo/deployklaw.md b/docs/HowTo/deployklaw.md
@@ -4,7 +4,7 @@ Learn how to deploy Klaw with an outline of steps and key points for a smooth up
 
 ## Klaw releases cycle
 
-Our team, along with Klaw's contributors, is committed to enhancing the functionality and efficiency of Klaw, aiming to deliver new updates approximately every 1.5 months. You can access all past and the most recent releases [here](../category/Releases). Highlighted updates include versions such as 2.4.0, 2.5.0, among others.
+Our team, along with Klaw's contributors, is committed to enhancing the functionality and efficiency of Klaw, aiming to deliver new updates approximately every 1.5 months. You can access all past and the most recent releases [here](../../docs/category/Releases). Highlighted updates include versions such as 2.4.0, 2.5.0, among others.
 
 ## Deployment strategy
 

diff --git a/docs/HowTo/installation/run-docker.md b/docs/HowTo/installation/run-docker.md
@@ -170,17 +170,15 @@ To verify the installation and access Klaw, follow the steps below:
 
 ### 5. Next Steps
 
-After successfully verifying your installation, recommend following the documentation in `configure-klaw-wizard`
-{.interpreted-text
-role="doc"}.
+After successfully verifying your installation,
+follow the documentation in [Configure Klaw with Wizard](../installation/configure-klaw-wizard.md).
 
 ## Klaw Docker Scripts
 
 Klaw also provides Docker scripts you can download from the
 project's GitHub repository. These scripts include a README file that
 explains how to build and deploy the latest version of Klaw. You can
-find these scripts at
-<https://github.com/aiven/klaw/tree/main/docker-scripts>.
+find these scripts at in [docker-scripts](https://github.com/aiven/klaw/tree/main/docker-scripts).
 
 ## Enabling HTTPS
 
@@ -193,7 +191,7 @@ keystore and truststore to the Klaw data volume so that they can be accessed at
 To find the location of the Klaw Docker volume, run the following
 command with your container ID:
 
-    docker inspect -f '{{ .Mounts }}' containerid
+`docker inspect -f '{{ .Mounts }}' containerid`
 
 ### Linux
 

diff --git a/docs/HowTo/settings.md b/docs/HowTo/settings.md
@@ -15,10 +15,8 @@ notification templates and roles, under **Dashboard -\> Settings**.
   this by updating the property `klaw.adduser.roles`.
 - **Tenant Configuration**  
   A tenant is an isolated environment that
-  has its own set of clusters, environments, users, teams, and topics
-  For more information, see `tenant-config`{.interpreted-text
-  role="doc"} documentation. You can change the hierarchy of
-  environments and a few other configurations by updating the property
+  has its own set of clusters, environments, users, teams, and topics.
+  For more information, see [Tenant configuration](./kafka-cluster-migration/tenant-config.md). You can change the hierarchy of environments and a few other configurations by updating the property
   `klaw.tenant.config`.
 - **Environment names**  
   When adding a new Environment, predefined

diff --git a/docs/HowTo/zothers.md b/docs/HowTo/zothers.md
@@ -10,4 +10,4 @@
   suggestion or improvement, we recommend you submit an issue to the
   project. You can do this by clicking on help and selecting **Raise
   a git issue** option, or you can directly open an issue by accessing
-  this link: <https://github.com/aiven/klaw/issues>
+  this link: [GitHub issues](https://github.com/aiven/klaw/issues)
diff --git a/docs/Releases/release100.md b/docs/Releases/release100.md
@@ -12,7 +12,7 @@ Klaw version 1.0.0 is a first major release.
 
 - Klaw (formerly Kafkawize) Initial Release 1.0.0
 - This release is cloned from main branch of
-  <https://github.com/muralibasani/kafkawize>
+  [Kafkawize](https://github.com/muralibasani/kafkawize)
 - Package renamed to `io.aiven.klaw`
 - Introduced 'Kafka flavor' in the configuration of clusters
 - Changes to manage Aiven ACLs
@@ -23,4 +23,4 @@ Klaw version 1.0.0 is a first major release.
 
 :::note
 Read more or Download the release
-<https://github.com/aiven/klaw/releases/tag/1.0.0>
+[GitHub release tag 1.0.0](https://github.com/aiven/klaw/releases/tag/1.0.0)
diff --git a/docs/Releases/release110.md b/docs/Releases/release110.md
@@ -30,4 +30,4 @@ improvements.
 
 :::note
 Read more or Download the release
-<https://github.com/aiven/klaw/releases/tag/v1.1.0>
+[GitHub release tag v1.1.0](https://github.com/aiven/klaw/releases/tag/v1.1.0)
diff --git a/docs/Releases/release120.md b/docs/Releases/release120.md
@@ -110,4 +110,4 @@ policy, retention period, flush interval, and more.
 
 :::note
 For a complete list of improvements, changelog, and to download the
-release, see <https://github.com/aiven/klaw/releases/tag/v1.2.0>
+release, see [GitHub release tag v1.2.0](https://github.com/aiven/klaw/releases/tag/v1.2.0)
diff --git a/docs/Releases/release200.md b/docs/Releases/release200.md
@@ -58,7 +58,7 @@ force-register the schema in case of any compatibility issues during
 registration.
 
 For more information, see [Schema
-Promotion](../../docs/Concepts/promotion.md#schema-promotion).
+Promotion](../../docs/HowTo/schemas/Promote-a-schema).
 
 ### Authorization from OAuth2 Provider/Active Directory
 
@@ -77,4 +77,4 @@ To enable the authorization feature, set the below property to value
 
 :::note
 For a complete list of improvements, changelog, and to download the
-release, see <https://github.com/aiven/klaw/releases/tag/v2.0.0>
+release, see [GitHub release tag v2.0.0](https://github.com/aiven/klaw/releases/tag/v2.0.0)
diff --git a/docs/Releases/release210.md b/docs/Releases/release210.md
@@ -57,7 +57,7 @@ includes the implementation of the following APIs:
   (v3)](<https://docs.confluent.io/cloud/current/api.html#tag/ACL-(v3)>)
 
 For more information, see [Confluent
-Cloud](../../docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol.md).
+Cloud](../../docs/HowTo/clusterconnectivity/confluent-cloud-kafka-cluster-ssl-protocol).
 
 ### Switch Teams
 
@@ -69,8 +69,8 @@ from increased flexibility and efficiency when working within the Klaw
 platform, particularly when creating or approving requests.
 
 For more information, see [Switch
-Teams](../../docs/Concepts/switch-teams.md).
+Teams](../../docs/Concepts/switch-teams).
 
 :::note
 For a complete list of improvements, changelog, and to download the
-release, see <https://github.com/aiven/klaw/releases/tag/v2.1.0>
+release, see [GitHub release tag v2.1.0](https://github.com/aiven/klaw/releases/tag/v2.1.0)
diff --git a/docs/Releases/release220.md b/docs/Releases/release220.md
@@ -67,8 +67,8 @@ feature provides administrators with additional backup and recovery
 options, enabling them to manage the system more effectively.
 
 For more information, see [Export Klaw
-data](../../docs/HowTo/exportimport/exportdata.md).
+data](../../docs/HowTo/exportimport/exportdata).
 
 :::note
 For a complete list of improvements, changelog, and to download the
-release, see <https://github.com/aiven/klaw/releases/tag/v2.2.0>
+release, see [GitHub release tag v2.2.0](https://github.com/aiven/klaw/releases/tag/v2.2.0)
diff --git a/docs/Releases/release230.md b/docs/Releases/release230.md
@@ -77,4 +77,4 @@ pattern. Previously, only prefix or suffix validation was available.
 
 :::note
 For a complete list of improvements, changelog, and to download the
-release, see <https://github.com/aiven/klaw/releases/tag/v2.3.0>
+release, see [GitHub release v2.3.0](https://github.com/aiven/klaw/releases/tag/v2.3.0)
diff --git a/docs/Releases/release240.md b/docs/Releases/release240.md
@@ -98,4 +98,4 @@ frontend.
 
 :::note
 For a complete list of improvements, changelog, and to download the
-release, see <https://github.com/aiven/klaw/releases/tag/v2.4.0>
+release, see [GitHub release tag v2.4.0](https://github.com/aiven/klaw/releases/tagv2.4.0)
diff --git a/docs/Releases/release250.md b/docs/Releases/release250.md
@@ -107,4 +107,4 @@ The superadmin can now use the "Schemas From Cluster" functionality to identify
 
 :::note
 For a complete list of improvements, changelog, and to download the
-release, see <https://github.com/aiven/klaw/releases/tag/v2.5.0>
+release, see [GitHub release tag v2.5.0](https://github.com/aiven/klaw/releases/tag/v2.5.0)
diff --git a/docs/Releases/release251.md b/docs/Releases/release251.md
@@ -36,4 +36,4 @@ Klaw version 2.5.1 is a patch release primarily aimed at enhancing MySQL support
 
 :::note
 For a complete list of improvements, changelog, and to download the release,
-see <https://github.com/aiven/klaw/releases/tag/v2.5.1>
+see [GitHub release tag v2.5.1](https://github.com/aiven/klaw/releases/tag/v2.5.1)
diff --git a/docs/Releases/release252.md b/docs/Releases/release252.md
@@ -29,4 +29,4 @@ Klaw version 2.5.2 is a patch release which removes some unused analytics code,
 
 :::note
 For a complete list of improvements, changelog, and to download the release,
-see <https://github.com/aiven/klaw/releases/tag/v2.5.2>
+see [GitHub release tag v2.5.2](https://github.com/aiven/klaw/releases/tag/v2.5.2)
diff --git a/docs/Releases/release260.md b/docs/Releases/release260.md
@@ -75,4 +75,4 @@ You can now configure the `klaw.notification.header.logo` property in the `appli
 
 :::note
 For a complete list of improvements, changelog, and to download the
-release, see <https://github.com/aiven/klaw/releases/tag/v.2.6.0>
+release, see [GitHub release tag v.2.6.0](https://github.com/aiven/klaw/releases/tag/v.2.6.0)
diff --git a/docs/Releases/release261.md b/docs/Releases/release261.md
@@ -29,4 +29,4 @@ Klaw version 2.6.1 is a patch release which removes some unused analytics code,
 
 :::note
 For a complete list of improvements, changelog, and to download the
-release, see <https://github.com/aiven/klaw/releases/tag/v2.6.1>
+release, see [GitHub release tag v2.6.1](https://github.com/aiven/klaw/releases/tag/v2.6.1)
diff --git a/docs/getstarted.md b/docs/getstarted.md
@@ -55,16 +55,17 @@ setting.
 An example value for a simple `DEV` environment might look something
 like this:
 
-    {
-     "tenantModel":
-     {
-      "tenantName": "default",
-      "baseSyncEnvironment": "DEV",
-      "orderOfTopicPromotionEnvsList": ["DEV", "TST"],
-      "requestTopicsEnvironmentsList": ["DEV", "TST"],
-      "baseSyncKafkaConnectCluster": null,
-      "orderOfConnectorsPromotionEnvsList": [],
-      "requestSchemaEnvironmentsList": [],
-      "requestConnectorsEnvironmentsList": []
-     }
-    }
+```json
+{
+  "tenantModel": {
+    "tenantName": "default",
+    "baseSyncEnvironment": "DEV",
+    "orderOfTopicPromotionEnvsList": ["DEV", "TST"],
+    "requestTopicsEnvironmentsList": ["DEV", "TST"],
+    "baseSyncKafkaConnectCluster": null,
+    "orderOfConnectorsPromotionEnvsList": [],
+    "requestSchemaEnvironmentsList": [],
+    "requestConnectorsEnvironmentsList": []
+  }
+}
+```
diff --git a/docs/index.md b/docs/index.md
@@ -13,4 +13,4 @@ Klaw consists of two components:
 ## Quickstart
 
 Copy the docker script and run. It installs Klaw, Apache Kafka, and schema Schema Registry servers as docker processes. [**Go through
-this guide**](./quickstart.md)
+this guide**](./quickstart)
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -1,8 +1,8 @@
 // @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 lightCodeTheme = require("prism-react-renderer").themes.github;
+const darkCodeTheme = require("prism-react-renderer").themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {