Reorganize docs around configuration and usage (#332)

* Reorganize and edit features and plugin documents * Add redirects and synchronize docs
kubeshop · May 24, 2024 · e692f36 · e692f36
1 parent 1ef64f9
commit e692f36
Show file tree

Hide file tree

Showing 229 changed files with 2,735 additions and 2,683 deletions.
diff --git a/docs/architecture/index.md b/docs/architecture/index.md
@@ -1,15 +1,15 @@
 ---
 id: architecture
 title: "Architecture"
-sidebar_position: 7
+sidebar_position: 8
 ---
 
 This document describes high-level Botkube architecture, all components in the system and interactions between them.
 
 Botkube is split into two main parts:
 
 - Botkube agent: Botkube binary that serves as a bridge between communication platforms (e.g. Slack, Discord) and Botkube plugins (sources and executors).
-- [Botkube plugins](../plugin/index.md): The executable binaries that communicate with Botkube agent over an RPC interface. Botkube supports two types of plugins, respectively called Source plugins and Executor plugins.
+- [Botkube plugins](../plugins/index.md): The executable binaries that communicate with Botkube agent over an RPC interface. Botkube supports two types of plugins, respectively called Source plugins and Executor plugins.
 
 ## Components
 

diff --git a/docs/architecture/teams.md b/docs/architecture/teams.md
@@ -1,10 +1,8 @@
 ---
 id: cloud-teams
-title: "Cloud Teams connections overview"
+title: "Botkube app for Microsoft Teams"
 ---
 
-# Cloud Teams connections overview
-
 This document describes the communication between the Botkube Cloud control-plane and the Botkube Agent configured with the Cloud Teams platform enabled.
 
 ![teams-cloud.svg](assets/teams-cloud.png)
@@ -49,7 +47,7 @@ During startup, the Botkube Agent downloads plugins index and all enabled plugin
 
 Each plugin may define required external dependencies that are downloaded by the [Plugin manager](#plugin-manager) at Agent startup. For now, those dependencies are taken from the official sources and are not mirrored to the Botkube Cloud registry. Here are the links that describe external dependencies for each officially supported plugin:
 
-- [`kubectl`](../configuration/executor/kubectl.md) executor: https://github.com/kubeshop/botkube/blob/release-1.9/internal/executor/kubectl/executor.go#L33-L42
+- [`kubectl`](../plugins/kubectl.md) executor: https://github.com/kubeshop/botkube/blob/release-1.9/internal/executor/kubectl/executor.go#L33-L42
 
 `helm` plugin:
 
@@ -125,8 +123,8 @@ Such constrains applies in the context of the Cloud organization:
 
 ## Useful links
 
-- [Botkube Agent architecture](https://docs.botkube.io/architecture/)
-- [Cloud Teams installation tutorial](https://docs.botkube.io/installation/teams/)
+- [Botkube Agent architecture](./index.md)
+- [Cloud Teams installation tutorial](../installation/teams/index.md)
 
 ## Terminology
 

diff --git a/docs/configuration/alias.md b/docs/configuration/alias.md
diff --git a/docs/configuration/executor/exec.md b/docs/configuration/executor/exec.md
diff --git a/docs/configuration/executor/flux.md b/docs/configuration/executor/flux.md
diff --git a/docs/configuration/executor/helm.md b/docs/configuration/executor/helm.md
diff --git a/docs/configuration/executor/kubectl.md b/docs/configuration/executor/kubectl.md