Skip to content

Commit

Permalink
Introduce Fuse docs (#344)
Browse files Browse the repository at this point in the history
- Introduce Fuse documentation with separate versioning
- Add homepage with Botkube product selection
- Nest Botkube Chat Platform docs under `/chat-platform`
- Add "Overview" doc for Botkube Chat Platform solution
- Bump Docusaurus
  • Loading branch information
pkosiec authored Sep 27, 2024
1 parent a83c148 commit 766536a
Show file tree
Hide file tree
Showing 989 changed files with 3,862 additions and 1,322 deletions.
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: Release
name: Botkube Chat Platform Release

on:
workflow_dispatch:
inputs:
version:
type: string
description: Version of the next release
description: Version of the next release (e.g. 1.13)
required: true

env:
Expand All @@ -30,23 +30,15 @@ jobs:
with:
go-version-file: magefiles/go.mod

- name: Validate release version
uses: magefile/mage-action@v2
with:
version: latest
args: "release:ensureBotkubeReleased"
env:
BOTKUBE_RELEASE_VERSION: "${{ inputs.version }}.0"

- name: Set git 'user.name' and 'user.email'
run: |
git config user.name "${{ env.git-user }}"
git config user.email ${{ env.git-email }}
- name: Create a release branch
run: |
git checkout -b release/${{ inputs.version }}
git push --set-upstream origin release/${{ inputs.version }}
git checkout -b fuse-release/${{ inputs.version }}
git push --set-upstream origin fuse-release/${{ inputs.version }}
npm install
- name: Update versions in installation docs
Expand All @@ -55,7 +47,7 @@ jobs:
uses: magefile/mage-action@v2
with:
version: latest
args: "release:updateDocsVersion"
args: "release:updateBotkubeChatPlatformDocsVersion"

- name: Synchronize helm parameters
uses: magefile/mage-action@v2
Expand All @@ -73,9 +65,9 @@ jobs:
env:
BOTKUBE_RELEASE_BRANCH: release-${{ inputs.version }}

- name: Run docusaurus versioning
- name: Run Docusaurus versioning
run: |
npm run docusaurus docs:version ${{ inputs.version }}
npm run docusaurus docs:version:chatPlatform ${{ inputs.version }}
- name: Prettier check
run: |
Expand All @@ -84,7 +76,7 @@ jobs:
- name: Push changes to remote
run: |
git add .
git commit -m "Prepare docs for ${{ inputs.version }} release"
git commit -m "Prepare docs for Botkube ${{ inputs.version }} release"
git push
git push origin release/${{ inputs.version }}
Expand All @@ -93,8 +85,8 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
run: |
gh pr create \
--title "Prepare docs for ${{ inputs.version }} release" \
--title "Prepare docs for Botkube ${{ inputs.version }} release" \
--head "release/${{ inputs.version }}" \
--base main \
--label release-automation \
--body "This Pull Request is created by release automation to prepare release for ${{ inputs.version }} documentation"
--body "This Pull Request is created by release automation to prepare release for Botkube ${{ inputs.version }} documentation"
76 changes: 76 additions & 0 deletions .github/workflows/fuse-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Fuse CLI Release

on:
workflow_dispatch:
inputs:
version:
type: string
description: Version of the next release (e.g. 0.6)
required: true

env:
git-user: github-actions[bot]
git-email: 41898282+github-actions[bot]@users.noreply.github.com

jobs:
release:
name: Create Fuse release ${{ inputs.version }}
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
with:
token: ${{ secrets.GH_TOKEN }}
fetch-depth: 0

- name: Setup Node
uses: volta-cli/action@v4

- name: Setup Go
uses: actions/setup-go@v3
with:
go-version-file: magefiles/go.mod

- name: Set git 'user.name' and 'user.email'
run: |
git config user.name "${{ env.git-user }}"
git config user.email ${{ env.git-email }}
- name: Create a release branch
run: |
git checkout -b fuse-release/${{ inputs.version }}
git push --set-upstream origin fuse-release/${{ inputs.version }}
npm install
- name: Update versions in installation docs
env:
LATEST_RELEASE_VERSION: "${{ inputs.version }}.0"
uses: magefile/mage-action@v2
with:
version: latest
args: "release:updateDocsVersion"

- name: Run Docusaurus versioning
run: |
npm run docusaurus docs:version ${{ inputs.version }}
- name: Prettier check
run: |
npm run prettier:fix
- name: Push changes to remote
run: |
git add .
git commit -m "Prepare docs for Fuse CLI ${{ inputs.version }} release"
git push
git push origin fuse-release/${{ inputs.version }}
- name: Create a pull request
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
run: |
gh pr create \
--title "Prepare docs for Fuse CLI ${{ inputs.version }} release" \
--head "fuse-release/${{ inputs.version }}" \
--base main \
--label release-automation \
--body "This Pull Request is created by release automation to prepare release for Fuse CLI ${{ inputs.version }} documentation"
File renamed without changes
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: architecture
title: "Architecture"
sidebar_position: 8
sidebar_position: 9
---

This document describes high-level Botkube architecture, all components in the system and interactions between them.
Expand Down
File renamed without changes.
4 changes: 4 additions & 0 deletions chat-platform-docs/cli/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Botkube CLI",
"position": 6
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions chat-platform-docs/community/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Community",
"position": 999
}
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To develop the outgoing webhook integration, you can use [Echo-Server](https://g
helm install echo-server ealenn/echo-server --set application.logs.ignore.ping=true --set application.enable.environment=false --wait
```

1. Go through the [Outgoing Webhook Botkube installation](/installation/webhook/) instruction. Provide `http://echo-server.default` as `WEBHOOK_URL`.
1. Go through the [Outgoing Webhook Botkube installation](../../installation/webhook/) instruction. Provide `http://echo-server.default` as `WEBHOOK_URL`.

1. Watch the logs:

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Tutorials and examples",
"position": 2
"position": 3
}
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Features",
"position": 3
"position": 4
}
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Aliases are defined globally for the whole Botkube installation.

You can configure aliases in the Botkube Cloud dashboard.

1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs.
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/slack/index.md) docs.
2. From the [Botkube Cloud homepage](https://app.botkube.io), click the **Aliases** link in the top right corner.
3. Click **Create new** button.
4. Provide display name, alias and command.
Expand Down
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions chat-platform-docs/installation/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Installation",
"position": 2
}
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
65 changes: 36 additions & 29 deletions docs/installation/index.mdx → chat-platform-docs/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,23 +1,48 @@
---
id: installation
title: Installation
id: overview
title: Overview
sidebar_position: 1
slug: /
---

import { IntegrationList } from "@site/src/components/IntegrationList";
# Overview

Botkube is the AI-Powered Kubernetes troubleshooting platform for everybody running Kubernetes clusters.

Botkube empowers DevOps teams to work more efficiently, enables developers to troubleshoot their applications without special Kubernetes access or knowledge, and improves reliability by delivering timely, context-enhanced notifications about events in your Kubernetes environments.

## What is Botkube?
It integrates with multiple platforms, such as Slack, Microsoft Teams, Discord and Mattermost. Botkube receives events from various sources, allows you to securely run commands, and run automated actions triggered by any of the plugins Botkube supports or your own custom plugins.

Botkube is a troubleshooting and monitoring solution that empowers DevOps teams to work more efficiently, enables developers to troubleshoot their applications without special Kubernetes access or knowledge, and improves reliability by delivering timely, context-enhanced notifications about events in your Kubernetes environments.
## Features

It integrates with multiple platforms, such as Slack, Microsoft Teams, Discord and Mattermost. Botkube monitors events from various sources, allows you to securely run commands, and run automated actions triggered by any of the plugins Botkube supports or your own custom plugins.
- Real-Time Collaboration: Share alerts and troubleshoot with
your team in Slack or Microsoft Teams
- Familiar Interface: Clear, rich messages for quick understanding
K8s Agent Setup: Requires Install an agent in your cluster for
full features.
- Admin Access Needed: Requires admin permissions to set up in
Slack or Teams.

## Feature map
## Supported integrations

:::tip
You can enable multiple platform integrations using a single Botkube agent. <br/>
:::

Learn about Botkube features and their availability in different integrations.
import { IntegrationList } from "@site/src/components/IntegrationList";

### Bots
<IntegrationList
integrations={[
{ name: "Slack", image: "/images/integrations/slack.svg", link: "installation/slack" },
{ name: "Mattermost", image: "/images/integrations/mattermost.svg", link: "installation/mattermost" },
{ name: "Discord", image: "/images/integrations/discord.svg", link: "installation/discord" },
{ name: "Teams", image: "/images/integrations/msteams.svg", link: "installation/teams" },
{ name: "Elasticsearch", image: "/images/integrations/elasticsearch.svg", link: "installation/elasticsearch" },
{ name: "PagerDuty", image: "/images/integrations/pager-duty.svg", link: "installation/pagerduty" },
{ name: "Webhook", image: "/images/integrations/webhooks.svg", link: "installation/webhook" },
]}
/>

### Bot features

Compare our bidirectional integrations:

Expand All @@ -31,29 +56,11 @@ Compare our bidirectional integrations:
| Actionable notifications | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: |
| Emoji reactions | :heavy_check_mark: | :x: | :x: | :x: | :x: |

### Sinks
### Sink features

Compare our unidirectional integrations:

| Feature | Elasticsearch | Webhook | PagerDuty |
| -------------------------------------------------------------- | ------------------ | ------------------ | ------------------ |
| Source plugins support (e.g. `kubernetes`, `prometheus`, etc.) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Multi-cluster support | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |

## Integrations

:::tip
You can enable multiple platform integrations using a single Botkube agent. <br/>
:::

<IntegrationList
integrations={[
{ name: "Slack", image: "/images/integrations/slack.svg", link: "installation/slack" },
{ name: "Mattermost", image: "/images/integrations/mattermost.svg", link: "installation/mattermost" },
{ name: "Discord", image: "/images/integrations/discord.svg", link: "installation/discord" },
{ name: "Teams", image: "/images/integrations/msteams.svg", link: "installation/teams" },
{ name: "Elasticsearch", image: "/images/integrations/elasticsearch.svg", link: "installation/elasticsearch" },
{ name: "PagerDuty", image: "/images/integrations/pager-duty.svg", link: "installation/pagerduty" },
{ name: "Webhook", image: "/images/integrations/webhooks.svg", link: "installation/webhook" },
]}
/>
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The plugin provides the following features:

You can enable the plugin as a part of Botkube instance configuration.

1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs.
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/slack/index.md) docs.
2. From the [Botkube Cloud homepage](https://app.botkube.io), click on a card of a given Botkube instance.
3. Navigate to the platform tab which you want to configure.
4. Click **Add plugin** button.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Also, remember to create RBAC resources for the plugin. See the [Prepare elevate

You can enable the plugin as a part of Botkube instance configuration.

1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs.
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/slack/index.md) docs.
2. From the [Botkube Cloud homepage](https://app.botkube.io), click on a card of a given Botkube instance.
3. Navigate to the platform tab which you want to configure.
4. Click **Add plugin** button.
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ By default, the read-only `KUBECONFIG` is assigned. For enabling commands that r

You can enable the plugin as a part of Botkube instance configuration.

1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs.
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/slack/index.md) docs.
2. From the [Botkube Cloud homepage](https://app.botkube.io), click on a card of a given Botkube instance.
3. Navigate to the platform tab which you want to configure.
4. Click **Add plugin** button.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Next, use the `flux` group in the plugin RBAC configuration:

You can enable the plugin as a part of Botkube instance configuration.

1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs.
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/slack/index.md) docs.
2. From the [Botkube Cloud homepage](https://app.botkube.io), click on a card of a given Botkube instance.
3. Navigate to the platform tab which you want to configure.
4. Click **Add plugin** button.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The GitHub Events source sends events for configured GitHub repositories. These

You can enable the plugin as a part of Botkube instance configuration.

1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs.
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/slack/index.md) docs.
2. From the [Botkube Cloud homepage](https://app.botkube.io), click on a card of a given Botkube instance.
3. Navigate to the platform tab which you want to configure.
4. Click **Add plugin** button.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ By default, just the read-only `helm` commands are supported. For enabling comma

You can enable the plugin as a part of Botkube instance configuration.

1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs.
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/slack/index.md) docs.
2. From the [Botkube Cloud homepage](https://app.botkube.io), click on a card of a given Botkube instance.
3. Navigate to the platform tab which you want to configure.
4. Click **Add plugin** button.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: plugins
title: Plugins
sidebar_position: 4
sidebar_position: 5
---

This section aggregates all officially maintained Botkube plugins. Some of them require active [Botkube Cloud](https://app.botkube.io) account.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Botkube Keptn source plugin allows you to consume events from Keptn deployme

You can enable the plugin as a part of Botkube instance configuration.

1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs.
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/slack/index.md) docs.
2. From the [Botkube Cloud homepage](https://app.botkube.io), click on a card of a given Botkube instance.
3. Navigate to the platform tab which you want to configure.
4. Click **Add plugin** button.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ By default, just the read-only `kubectl` commands are supported. For enabling co

You can enable the plugin as a part of Botkube instance configuration.

1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs.
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/slack/index.md) docs.
2. From the [Botkube Cloud homepage](https://app.botkube.io), click on a card of a given Botkube instance.
3. Navigate to the platform tab which you want to configure.
4. Click **Add plugin** button.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Kubernetes source plugin produces events for configured Kubernetes resources

You can enable the plugin as a part of Botkube instance configuration.

1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/index.mdx) docs.
1. If you don't have an existing Botkube instance, create a new one, according to the [Installation](../installation/slack/index.md) docs.
2. From the [Botkube Cloud homepage](https://app.botkube.io), click on a card of a given Botkube instance.
3. Navigate to the platform tab which you want to configure.
4. Click **Add plugin** button.
Expand Down
Loading

0 comments on commit 766536a

Please sign in to comment.