Upgrade Docusarus to v3 and fix all broken anchor links (#334)

* Upgrade Docusarus to v3 and fix all broken anchor links

* Fix release

* Add Botkube overview update

docs/examples-and-tutorials/getstarted/index.md

@@ -12,7 +12,7 @@ Welcome to Botkube! This guide will walk you through the process of setting up B
 
 ## Overview
 
-Botkube is a Kubernetes Monitoring and Tool designed to optimize your K8s workflow by providing real-time alerts from and commands within your Kubernetes environment. With Botkube, you can receive alerts, execute commands, and stay informed about your cluster's health and status, all from your preferred communication platform.
+Botkube is an AI-powered troubleshooting tool designed to optimize your K8s workflow by providing real-time alerts from and commands within your Kubernetes environment. With Botkube, you can receive alerts, execute commands, and stay informed about your cluster's health and status, all from your preferred communication platform.
 
 ## Step 1: Sign up for Botkube
 

docs/features/automated-actions.md

@@ -15,7 +15,7 @@ There are two predefined actions available:
 - `describe-created-resource` - describes a newly created resource,
 - `show-logs-on-error` - prints logs on Pod/StatefulSet/DaemonSet/Deployment error.
 
-Both of them are disabled by default. See details in the [Syntax](#syntax) section.
+Both of them are disabled by default.
 
 ## Action output
 

docs/installation/slack/socket-slack.md

@@ -21,7 +21,7 @@ Botkube uses interactive messaging to provide better experience. Interactive mes
 
 To learn more about the Slack Socket API limitation, see the [comment](https://github.com/slackapi/bolt-js/issues/1263#issuecomment-1006372826) in the official bot for Slack framework repository.
 
-The [Botkube Cloud App for Slack](#botkube-cloud-slack-app) does not have this limitation.
+The [Botkube Cloud App for Slack](./cloud-slack.mdx) does not have this limitation.
 :::
 
 Follow the steps below to create and install Botkube App for Slack to your Slack workspace.

docs/plugins/ai-assistant.mdx

@@ -53,7 +53,7 @@ import ReactPlayer from "react-player";
 
 Click on the **AI Help** button to get an analysis of the event.
 
-![AI Help](assets/ai-help-usage.png "AI Help")
+![AI Help](./assets/ai-help-usage.png "AI Help")
 
 ### AI questions and instructions
 

docs/plugins/development/repository.md

@@ -8,7 +8,7 @@ A plugin repository is a place where you store your plugin binaries. This reposi
 
 This document describes how to set up such repository. If you use or plan to use GitHub you can adapt the [template repository](quick-start.md) that has batteries included to start developing and hosting Botkube plugins right away.
 
-# Index file
+## Index file
 
 Your plugin repository must contain at least one index file and one plugin binary. Depending on your needs and preferences, you can create one or more index files to categorize your plugins. You can host both the executor and source plugins in a single repository. You can also include them in the same index file.
 
@@ -32,7 +32,7 @@ entries:
 
 It is not required to host a plugin or dependency binary on the same server as the index file.
 
-## Generate index file
+### Generate index file
 
 You can create the index file by yourself our use our tool to generate it automatically based on the directory with plugins binaries. The binaries must be named according to the following pattern:
 
@@ -74,14 +74,14 @@ You can create the index file by yourself our use our tool to generate it automa
    ```
 
    :::info
-   Replace the `-url-base-path` flag with the base path of your HTTP server. See [**Hosting plugins**](#host-plugins) for some examples.
+   Replace the `-url-base-path` flag with the base path of your HTTP server. See [Hosting plugins](#host-plugins) for some examples.
    :::
 
-# Host plugins
+## Host plugins
 
 This section describes example ways for serving Botkube plugins.
 
-## GitHub releases
+### GitHub releases
 
 A GitHub release allows you to upload additional assets that are later accessible with a predictable URL. When you generate the index file, specify the `-url-base-path` flag as `https://github.com/{owner}/{repo}/releases/download/{release_tag}`, for example, `https://github.com/kubeshop/botkube/releases/download/v1.0.0`.
 
@@ -94,11 +94,11 @@ gh release create v1.0.0 \
  ./plugins-index.yaml
 ```
 
-### Automation
+#### Automation
 
 You can use [GitHub Actions](https://docs.github.com/en/actions) to publish Botkube plugins automatically each time a new tag is pushed. See the [`release` workflow](https://github.com/kubeshop/botkube-plugins-template/blob/main/.github/workflows/release.yml) on the `botkube-plugins-template` repository for the out-of-the-box solution, which you can use and modify if needed.
 
-## GitHub pages
+### GitHub pages
 
 GitHub allows you to serve static pages via GitHub Pages. When you generate the index file, specify the `-url-base-path` flag as `https://{user}.github.io/{repository}`, for example, `https://kubeshop.github.io/botkube-plugins`.
 
@@ -150,11 +150,11 @@ GitHub allows you to serve static pages via GitHub Pages. When you generate the
 
 In such setup, you can use your default branch to store your plugins code, and the `gh-pages` branch as a plugin repository.
 
-### Automation
+#### Automation
 
 You can use [GitHub Actions](https://docs.github.com/en/actions) to publish Botkube plugins automatically each time a new tag is pushed. See the [`pages-release` workflow](https://github.com/kubeshop/botkube-plugins-template/blob/main/.github/workflows/pages-release.yml) on the `botkube-plugins-template` repository for the out-of-the-box solution, which you can use and modify if needed.
 
-## Use hosted plugins
+### Use hosted plugins
 
 To use the plugins that you published, add your repository under `plugins` in the [values.yaml](https://github.com/kubeshop/botkube/blob/main/helm/botkube/values.yaml) file for a given Botkube deployment. For example:
 

docs/self-hosted-configuration/communication/vault-csi.md

@@ -23,7 +23,7 @@ This tutorial shows how to install Botkube which takes the configuration from Va
   limactl start template://k3s
   ```
 
-- [Slack integration installed](../../installation/slack/#install-botkube-slack-app-to-your-slack-workspace).
+- [Socket Slack integration installed](../../installation/slack/socket-slack.md).
 - [`helm`](https://helm.sh/docs/intro/install/) v3 installed.
 - [`kubectl`](https://kubernetes.io/docs/tasks/tools/#kubectl) installed.
 
@@ -96,7 +96,7 @@ This instruction guides you through the installation of Botkube and Vault on a K
    --set syncSecret.enabled=true
    ```
 
-5. Create BotKue installation parameters:
+5. Create Botkube installation parameters:
 
    ```yaml
    cat > /tmp/values.yaml << ENDOFFILE

docs/self-hosted-configuration/helm-chart-parameters.md

@@ -15,17 +15,17 @@ For Botkube Cloud installations, the Botkube Agent configuration is managed via
 
 A virtual SRE, powered by AI.
 
-**Homepage:** <https://botkube.io>
+**Homepage:** [botkube.io](https://botkube.io)
 
 ## Maintainers
 
 | Name             | Email                 |
 | ---------------- | --------------------- |
-| Botkube Dev Team | <[email protected]> |
+| Botkube Dev Team | `[email protected]` |
 
 ## Source Code
 
-- <https://github.com/kubeshop/botkube>
+- [github.com/kubeshop/botkube](https://github.com/kubeshop/botkube)
 
 ## Parameters
 

docs/troubleshooting/common-problems.md

@@ -94,7 +94,7 @@ If you experience problems while configuring RBAC (Role-Based Access Control) fo
 
 ## Botkube doesn't respond on MS Teams
 
-In order to solve the problem, please refer to the [troubleshooting](../installation/teams/index.md#troubleshooting) guide for assistance.
+Microsoft Teams integration communicates via gRPC with the Botkube control-plane. In order to make this integration work, you need to allow access to `api.botkube.io`.
 
 ## I can't see my Slack private channels in Cloud Dashboard
 

docusaurus.config.js → docusaurus.config.ts

@@ -1,12 +1,13 @@
-// @ts-check
+import type { Config } from "@docusaurus/types";
 // Note: type annotations allow type checking and IDEs autocompletion
 const path = require("path");
-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 { createRedirects, redirects } = require("./redirects");
 
 /** @type {import('@docusaurus/types').Config} */
-const config = {
+const config: Config = {
   title: "Botkube",
   tagline: "Messaging bot for monitoring and debugging Kubernetes clusters",
   url: "https://docs.botkube.io/",
@@ -26,7 +27,7 @@ const config = {
     [
       "classic",
       /** @type {import('@docusaurus/preset-classic').Options} */
-      ({
+      {
         docs: {
           sidebarPath: require.resolve("./sidebars.js"),
           editUrl: "https://github.com/kubeshop/botkube-docs/edit/main/",
@@ -46,7 +47,7 @@ const config = {
         googleTagManager: {
           containerId: process.env.GOOGLE_TAG_MANAGER_CONTAINER_ID || "GTM-container-dev",
         },
-      }),
+      },
     ],
   ],
 
@@ -90,7 +91,7 @@ const config = {
 
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
-    ({
+    {
       image: "images/botkube-title-social.png",
       metadata: [
         {
@@ -237,7 +238,7 @@ const config = {
         textColor: "#091E42",
         isCloseable: true,
       },
-    }),
+    },
 };
 
 module.exports = config;

magefiles/target/release/update_docs_ver.go

@@ -25,7 +25,7 @@ func UpdateDocsVersion(latestRelVer string) {
 	previousRelVer += ".0" // add patch version
 
 	// Replace the version in the files
-	dirs := []string{"./docs/installation/", "./docs/configuration/", "./docs/operation/", "./docs/cli/"}
+	dirs := []string{"./docs/installation/", "./docs/features/", "./docs/plugins", "./docs/troubleshooting/", "./docs/cli/", "./docs/self-hosted-configuration"}
 	for _, dir := range dirs {
 		shx.MustCmdf(`find %s -type f \( -name "*.md" -o -name "*.mdx" \) -exec sed -i.bak "s/%s/%s/g" {} \;`, dir, previousRelVer, latestRelVer).MustRunV()
 	}