diff --git a/docs/assets/profile-init-setup.gif b/docs/assets/profile-init-setup.gif new file mode 100644 index 00000000..788d0d3e Binary files /dev/null and b/docs/assets/profile-init-setup.gif differ diff --git a/docs/assets/profile-post-setup.gif b/docs/assets/profile-post-setup.gif new file mode 100644 index 00000000..807dfe23 Binary files /dev/null and b/docs/assets/profile-post-setup.gif differ diff --git a/docs/assets/profile-usecase-helm.gif b/docs/assets/profile-usecase-helm.gif new file mode 100644 index 00000000..a7efb747 Binary files /dev/null and b/docs/assets/profile-usecase-helm.gif differ diff --git a/docs/assets/profile-usecase-scale.gif b/docs/assets/profile-usecase-scale.gif new file mode 100644 index 00000000..0e961fd2 Binary files /dev/null and b/docs/assets/profile-usecase-scale.gif differ diff --git a/docs/botkube-cloud-auth.md b/docs/botkube-cloud-auth.md index c63b2b5d..38bf05bc 100644 --- a/docs/botkube-cloud-auth.md +++ b/docs/botkube-cloud-auth.md @@ -1,7 +1,7 @@ --- id: botkube-cloud-auth title: Authentication with Botkube Cloud -sidebar_position: 8 +sidebar_position: 9 --- # Authentication with Botkube Cloud diff --git a/docs/env-profile.mdx b/docs/env-profile.mdx new file mode 100644 index 00000000..b390144c --- /dev/null +++ b/docs/env-profile.mdx @@ -0,0 +1,81 @@ +--- +id: env-profile +title: Environment profile +sidebar_position: 8 +--- + +# Environment profile + +To mitigate AI unpredictability, we have implemented several strategies to enhance its behavior and reliability. This page outlines the environment-specific details attached to chat sessions. + +Once created, the environment profile is linked to every new chat session. + +:::info +This feature requires [an active account on Botkube Cloud](./botkube-cloud-auth.md). The environment profile is shared across all Fuse installations within your Botkube Cloud organization. +::: + +## Setup + +The environment profile contains details about the resources related to your organization, such as which IaC or GitOps tools are in use, where the associated resources are stored, and how to access them. + +Below are the different flows based on your environment profile setup stage. + +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import postSetup from "./assets/profile-post-setup.gif"; +import initSetup from "./assets/profile-init-setup.gif"; + + + + When setting up the environment profile for the first time, you'll need to provide more details about your organization's tools and resource locations. + The local paths to these resources are specific to your installation, while general information is shared across all Fuse installations within your Botkube Cloud organization, ensuring that all team members can benefit from it out of the box. + + post-setup + + + + + The post-setup process is very simple. Fuse automatically detects if your organization already has a profile defined. The assistant proactively prompt you to provide the path to your Git repository, with no additional configuration required. + The entire process takes just a few seconds to complete. + + post-setup + + + + + +### View + +To view the environment profile, run: + +```shell +fuse config profile view +``` + +### Edit + +To edit the environment profile, run: + +```shell +fuse config profile edit +``` + +## Use cases + +The environment profile provides essential context for the AI when assisting with tasks. Below are examples of how the environment profile is leveraged to support common tasks: + +import helm from "./assets/profile-usecase-helm.gif"; +import scale from "./assets/profile-usecase-scale.gif"; + + + + helm + + + + + scale + + + +