Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove info about /botkubehelp command #142

Merged
merged 4 commits into from
Sep 19, 2022
Merged

Remove info about /botkubehelp command #142

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aee09cc
Remove info about /botkubehelp command
mszostok Sep 19, 2022
98a9385
Apply suggestions after review
mszostok Sep 19, 2022
2a73825
Run prettier
mszostok Sep 19, 2022
a295491
Update helm chart params
mszostok Sep 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/installation/discord/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Follow the steps below to install BotKube Discord app to your Discord server.

![discord_copy_client_id](assets/discord_copy_application_id.png)

4. Add a description - `BotKube is a messaging bot for monitoring and debugging Kubernetes clusters. Visit https://botkube.io/usage for help.`.
4. Add a description - `BotKube helps you monitor your Kubernetes cluster, debug critical deployments and gives recommendations for standard practices by running checks on the Kubernetes resources.`.

Set the BotKube icon (BotKube icon can be downloaded from [this link](https://github.com/kubeshop/botkube/raw/main/branding/logos/botkube_192x192.png)).

Expand Down
21 changes: 0 additions & 21 deletions docs/installation/mattermost/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,27 +58,6 @@ Export the channel name as an environment variable:
export MATTERMOST_CHANNEL="{channel_name}"
mszostok marked this conversation as resolved.
Show resolved Hide resolved
```

## Configure /botkubehelp Slash Command

**1.** First, go to **Main Menu > Integrations > Slash Commands**. (If you don’t have the Integrations option in your Main Menu, slash commands may not be enabled on your Mattermost server or maybe disabled for non-admins. Enable them from System Console > Integrations > Custom Integrations in prior versions)

**2.** Click **Add Slash Command** and add the following details for the command and click **Save**.

| Field | Value |
| -------------------- | ---------------------------------- |
| Title | BotKube |
| Description | Show BotKube help |
| Command Trigger Word | botkubehelp |
| Request URL | https://botkube.herokuapp.com/help |
| Request Method | POST |
| Autocomplete | True |

![mm_botkube_slash_cmd](assets/mm_botkube_slash_cmd.png)

**3.** Verify executing **/botkubehelp** in a channel.

![mm_botkube_help](assets/mm_botkube_help.png)

## Install BotKube in Kubernetes cluster

- We use [Helm](https://helm.sh/) to install BotKube in Kubernetes. Follow [this](https://docs.helm.sh/using_helm/#installing-helm) guide to install helm if you don't have it installed already.
Expand Down
22 changes: 11 additions & 11 deletions docs/installation/teams/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,17 @@ Then, configure your app by following the steps below,

5. Fill in the App details in the "Configure/Basic information" section.

| Field | Value |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| App name / Short name | BotKube |
| Descriptions / Short description | BotKube is a bot for your Kubernetes cluster |
| Descriptions / Long description | App that helps you monitor your Kubernetes cluster, debug critical deployments & gives recommendations for standard practices. |
| Version | 0.13.0 |
| Developer Information / Developer ... | BotKube |
| Developer Information / Website | https://botkube.io |
| App URLs / Privacy policy | https://botkube.io/privacy |
| App URLs / Terms of use | https://botkube.io/license |
| Application (client) ID | Add the Application (client) ID you obtained from Azure Active Directory |
| Field | Value |
|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| App name / Short name | BotKube |
| Descriptions / Short description | BotKube is a bot for your Kubernetes cluster |
| Descriptions / Long description | BotKube helps you monitor your Kubernetes cluster, debug critical deployments and gives recommendations for standard practices by running checks on the Kubernetes resources. |
| Version | 0.13.0 |
| Developer Information / Developer ... | BotKube |
| Developer Information / Website | https://botkube.io |
| App URLs / Privacy policy | https://botkube.io/privacy |
| App URLs / Terms of use | https://botkube.io/license |
| Application (client) ID | Add the Application (client) ID you obtained from Azure Active Directory |

![Developer Portal - Basic Information](assets/teams_add_app_info.png "Teams add app info")

Expand Down
Binary file modified docs/usage/assets/help.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/usage/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 3
## Debugging deployments using BotKube

@BotKube allows you to execute kubectl commands on your Kubernetes cluster.
Run **/botkubehelp** to find more information about the supported commands.
mszostok marked this conversation as resolved.
Show resolved Hide resolved
Run **@BotKube help** to find more information about the supported commands.

![help](assets/help.png)

Expand Down Expand Up @@ -67,7 +67,7 @@ Run **@BotKube ping** to the channel where BotKube is added. The BotKube will re
## Managing notifications

Depending upon your configuration, you will receive notifications about Kubernetes resources lifecycle events and their health.
BotKube bot allows you to enable/disable notifications on each configured channel separately. Run **/botkubehelp**, the bot will reply with the help message about the supported message formats.
BotKube bot allows you to enable/disable notifications on each configured channel separately. Run **@BotKube help**, the bot will reply with the help message about the supported message formats.

### View BotKube configuration

Expand Down