Improve AI plugin docs for self-hosted installation (#353)

docs/plugins/ai-assistant.mdx

@@ -26,6 +26,10 @@ The plugin provides the following features:
 
 ## Get started
 
+## Set up OpenAI Assistant
+
+Firstly, configure a new OpenAI Assistant. To do it, clone the [`botkube-plugins`](https://github.com/kubeshop/botkube-plugins) repository and follow the []`assistant-setup` instructions](https://github.com/kubeshop/botkube-plugins/tree/main/hack/assistant-setup).
+
 ## Enable the plugin
 
 Enable the plugin by adding [source](../self-hosted-configuration/source.md) and [executor](../self-hosted-configuration/executor.md) plugins to the Botkube configuration:
@@ -34,7 +38,7 @@ Enable the plugin by adding [source](../self-hosted-configuration/source.md) and
 sources:
   # ...
   ai-brain:
-    botkubeExtraPlugins/ai-brain:
+    botkubeExtra/ai-brain:
       displayName: "AI Brain"
       enabled: true
       context:
@@ -51,7 +55,7 @@ sources:
 executors:
   # ...
   ai:
-    botkubeExtraPlugins/ai:
+    botkubeExtra/ai:
       displayName: "AI"
       enabled: true
       context:
@@ -66,15 +70,32 @@ executors:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 
-Then, use the `ai` executor plugin in your [communication platform](../self-hosted-configuration/communication/index.md).
+Then, use the `ai` executor and `ai-brain` plugin in your [communication platform](../self-hosted-configuration/communication/index.md) configuration. For example:
+
+```yaml
+communications:
+  default-group:
+    socketSlack:
+      # ...
+      channels:
+        default:
+          # ...
+          bindings:
+            sources:
+              # ...
+              - ai-brain
+            executors:
+              # ...
+              - ai
+```
 
 ## Add the AI button to Kubernetes events
 
-Optionally, you can add the AI button to your Kubernetes events by adding the following snippet to the [Kubernetes plugin](./kubernetes.md):
+Optionally, you can add the AI button to your Kubernetes events. For example, to display the button for error events, add the following snippet to the [Kubernetes plugin](./kubernetes.md) configuration:
 
 ```yaml
 extraButtons:

docs/plugins/argocd.md

@@ -53,7 +53,7 @@ Enable the plugin by adding a new [source](../self-hosted-configuration/source.m
 ```yaml
 sources:
   "argocd":
-    botkubeExtraPlugins/argocd:
+    botkubeExtra/argocd:
       enabled: true
       context:
         rbac:
@@ -75,7 +75,7 @@ sources:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

docs/plugins/exec.mdx

@@ -28,14 +28,14 @@ Enable the plugin by adding a new [executor](../self-hosted-configuration/execut
 executors:
   # ...
   flux:
-    botkubeExtraPlugins/exec:
+    botkubeExtra/exec:
       displayName: "Exec"
       enabled: true
       config: # See the Configuration section for config properties.
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

docs/plugins/flux.md

@@ -51,7 +51,7 @@ Enable the plugin by adding a new [executor](../self-hosted-configuration/execut
 executors:
   # ...
   flux:
-    botkubeExtraPlugins/flux:
+    botkubeExtra/flux:
       displayName: "Flux"
       enabled: true
       context:
@@ -69,7 +69,7 @@ executors:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

docs/plugins/github-events.md

@@ -16,7 +16,7 @@ Enable the plugin by adding a new [source](../self-hosted-configuration/source.m
 sources:
   # ...
   gh-events:
-    botkubeExtraPlugins/github-events:
+    botkubeExtra/github-events:
       displayName: "GitHub Events"
       enabled: true
       config:
@@ -25,7 +25,7 @@ sources:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

docs/plugins/helm.md

@@ -18,7 +18,7 @@ Enable the plugin by adding a new [executor](../self-hosted-configuration/execut
 executors:
   # ...
   helm:
-    botkubeExtraPlugins/helm:
+    botkubeExtra/helm:
       displayName: "Helm"
       enabled: true
       context:
@@ -33,7 +33,7 @@ executors:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

docs/plugins/index.md

@@ -18,7 +18,7 @@ plugins:
   repositories:
     botkube:
       url: https://github.com/kubeshop/botkube/releases/download/v1.14.0/plugins-index.yaml
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

docs/plugins/keptn.md

@@ -16,7 +16,7 @@ Enable the plugin by adding a new [source](../self-hosted-configuration/source.m
 sources:
   # ...
   keptn:
-    botkubeExtraPlugins/keptn:
+    botkubeExtra/keptn:
       enabled: true
       config:
         url: "http://api-gateway-nginx.keptn.svc.cluster.local/api" # Keptn API Gateway URL.
@@ -26,7 +26,7 @@ sources:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

docs/plugins/prometheus.md

@@ -16,7 +16,7 @@ Enable the plugin by adding a new [source](../self-hosted-configuration/source.m
 sources:
   # ...
   prometheus:
-    botkubeExtraPlugins/prometheus:
+    botkubeExtra/prometheus:
       displayName: "Prometheus"
       enabled: true
       config:
@@ -27,7 +27,7 @@ sources:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

versioned_docs/version-1.13/plugins/ai-assistant.mdx

@@ -26,6 +26,10 @@ The plugin provides the following features:
 
 ## Get started
 
+## Set up OpenAI Assistant
+
+Firstly, configure a new OpenAI Assistant. To do it, clone the [`botkube-plugins`](https://github.com/kubeshop/botkube-plugins) repository and follow the []`assistant-setup` instructions](https://github.com/kubeshop/botkube-plugins/tree/main/hack/assistant-setup).
+
 ## Enable the plugin
 
 Enable the plugin by adding [source](../self-hosted-configuration/source.md) and [executor](../self-hosted-configuration/executor.md) plugins to the Botkube configuration:
@@ -34,7 +38,7 @@ Enable the plugin by adding [source](../self-hosted-configuration/source.md) and
 sources:
   # ...
   ai-brain:
-    botkubeExtraPlugins/ai-brain:
+    botkubeExtra/ai-brain:
       displayName: "AI Brain"
       enabled: true
       context:
@@ -51,7 +55,7 @@ sources:
 executors:
   # ...
   ai:
-    botkubeExtraPlugins/ai:
+    botkubeExtra/ai:
       displayName: "AI"
       enabled: true
       context:
@@ -66,15 +70,32 @@ executors:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 
-Then, use the `ai` executor plugin in your [communication platform](../self-hosted-configuration/communication/index.md).
+Then, use the `ai` executor and `ai-brain` plugin in your [communication platform](../self-hosted-configuration/communication/index.md) configuration. For example:
+
+```yaml
+communications:
+  default-group:
+    socketSlack:
+      # ...
+      channels:
+        default:
+          # ...
+          bindings:
+            sources:
+              # ...
+              - ai-brain
+            executors:
+              # ...
+              - ai
+```
 
 ## Add the AI button to Kubernetes events
 
-Optionally, you can add the AI button to your Kubernetes events by adding the following snippet to the [Kubernetes plugin](./kubernetes.md):
+Optionally, you can add the AI button to your Kubernetes events. For example, to display the button for error events, add the following snippet to the [Kubernetes plugin](./kubernetes.md) configuration:
 
 ```yaml
 extraButtons:
@@ -140,6 +161,7 @@ The `ai-brain` plugin supports the following configuration:
 ```yaml
 openAIAssistantID: "..." # OpenAI Assistant ID
 openAIAPIToken: "..." # OpenAI API Token
+openAIBaseURL: https://api.openai.com/v1 # Optional custom URL
 vectorStoreIDForThreads: "..." # Optional Vector Store ID for each thread. This allows file search capabilities for the AI plugin.
 ```
 

versioned_docs/version-1.13/plugins/argocd.md

@@ -53,7 +53,7 @@ Enable the plugin by adding a new [source](../self-hosted-configuration/source.m
 ```yaml
 sources:
   "argocd":
-    botkubeExtraPlugins/argocd:
+    botkubeExtra/argocd:
       enabled: true
       context:
         rbac:
@@ -75,7 +75,7 @@ sources:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

versioned_docs/version-1.13/plugins/exec.mdx

@@ -28,14 +28,14 @@ Enable the plugin by adding a new [executor](../self-hosted-configuration/execut
 executors:
   # ...
   flux:
-    botkubeExtraPlugins/exec:
+    botkubeExtra/exec:
       displayName: "Exec"
       enabled: true
       config: # See the Configuration section for config properties.
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

versioned_docs/version-1.13/plugins/flux.md

@@ -51,7 +51,7 @@ Enable the plugin by adding a new [executor](../self-hosted-configuration/execut
 executors:
   # ...
   flux:
-    botkubeExtraPlugins/flux:
+    botkubeExtra/flux:
       displayName: "Flux"
       enabled: true
       context:
@@ -69,7 +69,7 @@ executors:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

versioned_docs/version-1.13/plugins/github-events.md

@@ -16,7 +16,7 @@ Enable the plugin by adding a new [source](../self-hosted-configuration/source.m
 sources:
   # ...
   gh-events:
-    botkubeExtraPlugins/github-events:
+    botkubeExtra/github-events:
       displayName: "GitHub Events"
       enabled: true
       config:
@@ -25,7 +25,7 @@ sources:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

versioned_docs/version-1.13/plugins/helm.md

@@ -18,7 +18,7 @@ Enable the plugin by adding a new [executor](../self-hosted-configuration/execut
 executors:
   # ...
   helm:
-    botkubeExtraPlugins/helm:
+    botkubeExtra/helm:
       displayName: "Helm"
       enabled: true
       context:
@@ -33,7 +33,7 @@ executors:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

versioned_docs/version-1.13/plugins/index.md

@@ -18,7 +18,7 @@ plugins:
   repositories:
     botkube:
       url: https://github.com/kubeshop/botkube/releases/download/v1.14.0/plugins-index.yaml
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```
 

versioned_docs/version-1.13/plugins/keptn.md

@@ -16,7 +16,7 @@ Enable the plugin by adding a new [source](../self-hosted-configuration/source.m
 sources:
   # ...
   keptn:
-    botkubeExtraPlugins/keptn:
+    botkubeExtra/keptn:
       enabled: true
       config:
         url: "http://api-gateway-nginx.keptn.svc.cluster.local/api" # Keptn API Gateway URL.
@@ -26,7 +26,7 @@ sources:
 plugins:
   # ...
   repositories:
-    botkubeExtraPlugins:
+    botkubeExtra:
       url: https://github.com/kubeshop/botkube-plugins/releases/download/v1.14.0/plugins-index.yaml
 ```