kubeshop · pkosiec · Oct 7, 2024 · Oct 4, 2024 · Oct 7, 2024 · Oct 7, 2024
diff --git a/docs/custom-instructions.md b/docs/custom-instructions.md
@@ -0,0 +1,7 @@
+---
+id: custom-instructions
+title: Custom instructions
+sidebar_position: 6
+---
+
+# Custom instructions
diff --git a/docs/demo-environment.md b/docs/demo-environment.md
@@ -0,0 +1,13 @@
+---
+id: demo-environment
+title: Demo environment
+sidebar_position: 5
+---
+
+# Demo environment
+
+To make it easier to try out Fuse, we provide a demo environment.
+
+To use it, specify the `--with-demo-env` flag. By default, when running [`fuse scenarios`](./scenarios.md), you will be prompted if you want to use it as a part of the guided paths.
+
+The flag configures access to our public read-only Google Cloud Platform project with a Kubernetes cluster. All read-only operations are allowed.
diff --git a/docs/knowledge-documents.md b/docs/knowledge-documents.md
@@ -0,0 +1,25 @@
+---
+id: knowledge-documents
+title: Knowledge documents
+sidebar_position: 7
+---
+
+# Knowledge documents
+
+Make Fuse even smarter by uploading your documentation. For example: architectural documents, onboarding material, runbooks, post-mortems, etc.
+
+The user-supplied documentation is scoped to a given Botkube Cloud organization.
+
+Both free and paid plans support this feature, with separate limits.
+
+## Manage uploaded files
+
+To manage the files, follow the steps:
+
+1. Navigate to the [Botkube Cloud dashboard](https://app.botkube.io)
+2. Click on the **Fuse CLI** tab.
+3. Under the **Customize Fuse Installations** section, find the **Knowledge Documents** card.
+
+Upload new files with the **Upload file(s)** button.
+
+To delete files, select the file(s) you want to delete and click **Delete selected file(s)**.
diff --git a/docs/overview.md b/docs/overview.md
@@ -14,7 +14,7 @@ It helps you work smarter by:
 - Seamless tool integration,
 - Tailored assistance.
 
-Botkube Fuse delivers tailored guidance for your unique infrastructure, pipelines, and services via the interactive command line interface.
+Fuse delivers tailored guidance for your unique infrastructure, pipelines, and services via the interactive command line interface.
 
 ![Using fuse in CLI](./assets/prompt.gif)
 
@@ -30,7 +30,7 @@ Fuse categorizes your queries and applies custom AI assistant instructions for a
 
 During AI processing phase, Fuse integrates with your locally installed tools, with full control over the process.
 
-Available capabilities:
+Available capabilities are:
 
 - Google Cloud CLI (`gcloud`),
 - Kubernetes CLI (`kubectl`),
@@ -40,17 +40,6 @@ Available capabilities:
 - Filesystem operations,
 - and more!
 
-## Featured scenarios
-
-We believe that even the most powerful AI assistants out there still require some guidance. Someone needs to do the “prompt engineering” work. That’s why we introduced AI assistant guidance for different user scenarios. Currently, we focused on:
-
-- GitHub Actions secret management,
-- GitHub Actions pipeline run analysis,
-- GKE troubleshooting with IAM permission errors,
-- Local environment operations and debugging.
-
-See the [Looking for inspiration](./usage.md#looking-for-inspiration) section to learn how to check out the scenarios.
-
 ## 📖 Learn more
 
-Read more about Botkube Fuse features on [the official website](https://botkube.io/fuse/).
+Read more about Fuse features on [the official website](https://botkube.io/fuse/).
diff --git a/docs/scenarios.md b/docs/scenarios.md
@@ -0,0 +1,24 @@
+---
+id: scenarios
+title: Scenarios
+sidebar_position: 4
+---
+
+# Scenarios
+
+To browse available example use-cases, Run `fuse scenarios` in your terminal.
+
+Scenarios command contains guided paths to get started with Fuse. Simply select one of the scenarios, like "Getting summary of CI/CD pipeline runs", and pick one of the prompts.
+
+As a part of the Scenarios, you can configure optional access to the [Demo environment](./demo-environment.md).
+
+## Featured scenarios
+
+We believe that even the most powerful AI assistants out there still require some guidance. Someone needs to do the “prompt engineering” work. That’s why we introduced AI assistant guidance for different user scenarios. Currently, we focused on:
+
+- GitHub Actions secret management,
+- GitHub Actions pipeline run analysis,
+- GKE troubleshooting with IAM permission errors,
+- Local environment operations and debugging.
+
+You can see the video recordings of the scenarios on the [official landing page](https://botkube.io/fuse).
diff --git a/docs/usage.md b/docs/usage.md
@@ -37,6 +37,4 @@ fuse 'list files in the current directory and provide me better organization str
 
 ### Looking for inspiration?
 
-💡 If you are curious what Fuse can do for you, simply run `fuse scenarios` in your terminal!
-
-![scenarios.gif](./assets/scenarios.gif)
+Read the [Scenarios](./scenarios.md) document with guided paths to get started!
diff --git a/versioned_docs/version-0.5/scenarios.md b/versioned_docs/version-0.5/scenarios.md
@@ -0,0 +1,22 @@
+---
+id: scenarios
+title: Scenarios
+sidebar_position: 4
+---
+
+# Scenarios
+
+To browse available example use-cases, Run `fuse scenarios` in your terminal.
+
+Scenarios command contains guided paths to get started with Fuse. Simply select one of the scenarios, like "Getting summary of CI/CD pipeline runs", and pick one of the prompts.
+
+## Featured scenarios
+
+We believe that even the most powerful AI assistants out there still require some guidance. Someone needs to do the “prompt engineering” work. That’s why we introduced AI assistant guidance for different user scenarios. Currently, we focused on:
+
+- GitHub Actions secret management,
+- GitHub Actions pipeline run analysis,
+- GKE troubleshooting with IAM permission errors,
+- Local environment operations and debugging.
+
+You can see the video recordings of the scenarios on the [official landing page](https://botkube.io/fuse).
diff --git a/versioned_docs/version-0.5/usage.md b/versioned_docs/version-0.5/usage.md
@@ -37,6 +37,4 @@ fuse 'list files in the current directory and provide me better organization str
 
 ### Looking for inspiration?
 
-💡 If you are curious what Fuse can do for you, simply run `fuse scenarios` in your terminal!
-
-![scenarios.gif](./assets/scenarios.gif)
+Read the [Scenarios](./scenarios.md) document with guided paths to get started!
diff --git a/versioned_docs/version-0.6/assets/prompt.gif b/versioned_docs/version-0.6/assets/prompt.gif
diff --git a/versioned_docs/version-0.6/assets/scenarios.gif b/versioned_docs/version-0.6/assets/scenarios.gif
diff --git a/versioned_docs/version-0.6/custom-instructions.md b/versioned_docs/version-0.6/custom-instructions.md
@@ -0,0 +1,7 @@
+---
+id: custom-instructions
+title: Custom instructions
+sidebar_position: 6
+---
+
+# Custom instructions
diff --git a/versioned_docs/version-0.6/demo-environment.md b/versioned_docs/version-0.6/demo-environment.md
@@ -0,0 +1,13 @@
+---
+id: demo-environment
+title: Demo environment
+sidebar_position: 5
+---
+
+# Demo environment
+
+To make it easier to try out Fuse, we provide a demo environment.
+
+To use it, specify the `--with-demo-env` flag. By default, when running [`fuse scenarios`](./scenarios.md), you will be prompted if you want to use it as a part of the guided paths.
+
+The flag configures access to our public read-only Google Cloud Platform project with a Kubernetes cluster. All read-only operations are allowed.
diff --git a/versioned_docs/version-0.6/installation.mdx b/versioned_docs/version-0.6/installation.mdx
@@ -0,0 +1,123 @@
+---
+id: installation
+title: Installation
+sidebar_position: 2
+---
+
+## Installation
+
+Select tab depending on the system you use:
+
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+
+<Tabs groupId="cli">
+<TabItem value="macos-arm64" label="Mac with Apple Silicon" default>
+
+Use <a href="https://brew.sh" target="_blank" rel="noreferrer">Homebrew</a> to install the latest version of the Fuse CLI:
+
+```shell
+brew install kubeshop/fuse-releases/fuse
+```
+
+Upgrade the existing installation with:
+
+```shell
+brew upgrade kubeshop/fuse-releases/fuse
+```
+
+<hr />
+
+Alternatively, download the version of the Fuse CLI binary and move it to a directory under your `$PATH`:
+
+```shell
+curl -Lo fuse https://github.com/kubeshop/fuse-releases/releases/latest/download/fuse-darwin-arm64
+chmod +x fuse && mv fuse /usr/local/bin/fuse
+```
+
+</TabItem>
+
+<TabItem value="macos-amd64" label="Mac with Intel chip" default>
+
+Use <a href="https://brew.sh" target="_blank" rel="noreferrer">Homebrew</a> to install the latest version of the Fuse CLI:
+
+```shell
+brew install kubeshop/fuse-releases/fuse
+```
+
+Upgrade the existing installation with:
+
+```shell
+brew upgrade kubeshop/fuse-releases/fuse
+```
+
+<hr />
+
+Alternatively, download the version of the Fuse CLI binary and move it to a directory under your `$PATH`:
+
+```shell
+curl -Lo fuse https://github.com/kubeshop/fuse-releases/releases/latest/download/fuse-darwin-amd64
+chmod +x fuse && mv fuse /usr/local/bin/fuse
+```
+
+</TabItem>
+
+<TabItem value="linux" label="Linux">
+
+Download the version of the Fuse CLI binary and move it to a directory under your `$PATH`:
+
+```shell
+export ARCH=<your-arch> # allowed values: amd64, arm64, 386
+curl -Lo fuse https://github.com/kubeshop/fuse-releases/releases/latest/download/fuse-linux-${ARCH}
+chmod +x fuse && mv fuse /usr/local/bin/fuse
+```
+
+:::note
+You may need to use `sudo` to run the `mv` command as it moves the binary file to the `/usr/local/bin/` directory.
+:::
+
+<hr />
+
+Alternatively, if you use <a href="https://brew.sh" target="_blank" rel="noreferrer">Homebrew</a>, you can use it to install the latest version of the Fuse CLI:
+
+```shell
+brew install kubeshop/fuse-releases/fuse
+```
+
+Upgrade the existing installation with:
+
+```shell
+brew upgrade kubeshop/fuse-releases/fuse
+```
+
+</TabItem>
+
+<TabItem value="windows" label="Windows">
+
+Use <a href="https://curl.se/windows/" target="_blank" rel="noreferrer">curl</a> to download the version of the Fuse CLI binary:
+
+```shell
+curl -Lo fuse https://github.com/kubeshop/fuse-releases/releases/latest/download/fuse-windows-amd64.exe
+```
+
+Move the binary to a directory under your `%PATH%`.
+
+</TabItem>
+
+<TabItem value="other" label="Other">
+
+Use <a href="https://curl.se" target="_blank" rel="noreferrer">curl</a> to download the version of the Fuse CLI binary:
+
+```shell
+export OS=<your-os> # allowed values: darwin, linux, windows
+export ARCH=<your-arch> # allowed values: amd64, arm64, 386
+export SUFFIX="" # set to ".exe" if OS is 'windows'
+curl -Lo fuse https://github.com/kubeshop/fuse-releases/releases/latest/download/fuse-${OS}-${ARCH}${SUFFIX}
+chmod +x fuse && mv fuse /usr/local/bin/fuse
+```
+
+Move the binary to a directory under your `$PATH` or `%PATH%`, depending on your operating system.
+
+</TabItem>
+
+</Tabs>
diff --git a/versioned_docs/version-0.6/knowledge-documents.md b/versioned_docs/version-0.6/knowledge-documents.md
@@ -0,0 +1,25 @@
+---
+id: knowledge-documents
+title: Knowledge documents
+sidebar_position: 7
+---
+
+# Knowledge documents
+
+Make Fuse even smarter by uploading your documentation. For example: architectural documents, onboarding material, runbooks, post-mortems, etc.
+
+The user-supplied documentation is scoped to a given Botkube Cloud organization.
+
+Both free and paid plans support this feature, with separate limits.
+
+## Manage uploaded files
+
+To manage the files, follow the steps:
+
+1. Navigate to the [Botkube Cloud dashboard](https://app.botkube.io)
+2. Click on the **Fuse CLI** tab.
+3. Under the **Customize Fuse Installations** section, find the **Knowledge Documents** card.
+
+Upload new files with the **Upload file(s)** button.
+
+To delete files, select the file(s) you want to delete and click **Delete selected file(s)**.
diff --git a/versioned_docs/version-0.6/overview.md b/versioned_docs/version-0.6/overview.md
@@ -0,0 +1,45 @@
+---
+id: overview
+title: Overview
+sidebar_position: 1
+---
+
+# Overview
+
+Fuse CLI is the DevOps Copilot in a form of a CLI tool, that helps you reduce context switching.
+
+It helps you work smarter by:
+
+- In-depth expertise,
+- Seamless tool integration,
+- Tailored assistance.
+
+Fuse delivers tailored guidance for your unique infrastructure, pipelines, and services via the interactive command line interface.
+
+![Using fuse in CLI](./assets/prompt.gif)
+
+## What problem does it solve?
+
+In today’s fast-paced world, DevOps, SRE, and platform engineers constantly juggle multiple tasks—from navigating through various layers of a project while implementing new functionalities to answering developer questions and troubleshooting infrastructure issues. This constant context switching often leads to inefficiencies and burnout.
+
+We designed Fuse to solve the context switching problem for engineers that work with infrastructure, pipelines, and services.
+
+## How it works?
+
+Fuse categorizes your queries and applies custom AI assistant instructions for accurate responses.
+
+During AI processing phase, Fuse integrates with your locally installed tools, with full control over the process.
+
+Available capabilities are:
+
+- Google Cloud CLI (`gcloud`),
+- Kubernetes CLI (`kubectl`),
+- GitHub CLI (`gh`),
+- Git,
+- Python (arbitrary code execution),
+- Filesystem operations,
+- and more!
+
+## 📖 Learn more
+
+Read more about Fuse features on [the official website](https://botkube.io/fuse/).
diff --git a/versioned_docs/version-0.6/scenarios.md b/versioned_docs/version-0.6/scenarios.md
@@ -0,0 +1,24 @@
+---
+id: scenarios
+title: Scenarios
+sidebar_position: 4
+---
+
+# Scenarios
+
+To browse available example use-cases, Run `fuse scenarios` in your terminal.
+
+Scenarios command contains guided paths to get started with Fuse. Simply select one of the scenarios, like "Getting summary of CI/CD pipeline runs", and pick one of the prompts.
+
+As a part of the Scenarios, you can configure optional access to the [Demo environment](./demo-environment.md).
+
+## Featured scenarios
+
+We believe that even the most powerful AI assistants out there still require some guidance. Someone needs to do the “prompt engineering” work. That’s why we introduced AI assistant guidance for different user scenarios. Currently, we focused on:
+
+- GitHub Actions secret management,
+- GitHub Actions pipeline run analysis,
+- GKE troubleshooting with IAM permission errors,
+- Local environment operations and debugging.
+
+You can see the video recordings of the scenarios on the [official landing page](https://botkube.io/fuse).