From dcc92d3a17ac5f06b9a4fbe5b02cff7730df4afb Mon Sep 17 00:00:00 2001 From: Pawel Kosiec Date: Thu, 31 Aug 2023 14:22:58 +0200 Subject: [PATCH] Update document --- README.md | 50 +++++++--------------- docs/assets/icons/bug-line.svg | 1 - docs/assets/icons/cloud-line.svg | 1 - docs/assets/icons/question-answer-line.svg | 1 - docs/assets/icons/stack-line.svg | 1 - docs/assets/icons/terminal-box-line.svg | 1 - 6 files changed, 16 insertions(+), 39 deletions(-) delete mode 100644 docs/assets/icons/bug-line.svg delete mode 100644 docs/assets/icons/cloud-line.svg delete mode 100644 docs/assets/icons/question-answer-line.svg delete mode 100644 docs/assets/icons/stack-line.svg delete mode 100644 docs/assets/icons/terminal-box-line.svg diff --git a/README.md b/README.md index 2292bdaa0..9d399a0d7 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,6 @@ Botkube is a messaging bot for monitoring and debugging Kubernetes clusters.

-

Latest Release @@ -31,7 +30,7 @@ Botkube helps you monitor your Kubernetes cluster, debug critical deployments and gives recommendations for standard practices by running checks on the Kubernetes resources. It integrates with multiple communication platforms, such as [Slack](https://slack.com), [Discord](https://discord.com/), or [Mattermost](https://mattermost.com). -You can also execute `kubectl` commands on K8s cluster via Botkube which helps debugging an application or cluster. +You can also execute `kubectl`, `helm` and other commands on your K8s, which helps debugging an application or cluster.

@@ -39,51 +38,34 @@ You can also execute `kubectl` commands on K8s cluster via Botkube which helps d ## Getting started -Please follow [this](https://docs.botkube.io/installation/) for a complete Botkube installation guide. - -## Documentation - -For full documentation, visit [botkube.io](https://docs.botkube.io). The documentation sources reside on the [botkube-docs](https://github.com/kubeshop/botkube-docs) repository under **content** directory. +Follow [the official Botkube installation guide](https://docs.botkube.io/installation/) to get started. ## Features - - -### Execute `kubectl` commands - -The same `kubectl` capabilities inside your favorite communicator. You do not have to learn anything new! Plus, you can configure which `kubectl` commands Botkube can execute. See [configuration](https://docs.botkube.io/configuration/) for details. - -

+### 💬 Connect to your clusters from anywhere at any time - +Botkube intergrates with all common messaging platforms including: -### Use multiple communication platforms +- Teams +- Slack +- Discord +- Mattermost -Botkube integrates with Slack, Discord, Mattermost, Microsoft Teams, ElasticSearch and outgoing webhook. See [configuration](https://docs.botkube.io/configuration/communication/) syntax for details. +### 💡 Elevate your troubleshooting workflow with intelligent insights -

+Supercharge your technical workflow with our seamless alert consolidation and filtering. Gain automated intelligent insights to troubleshoot with precision and efficiency. Get alerted by Kubernetes, Prometheus, and other tools. - +### 🚀 See alerts, Take action -### Monitor any Kubernetes resource +Take your ChatOps experience to new heights and go beyond just monitoring. Seamlessly take action on your clusters with ease and efficiency. Access tools like `kubectl` and `helm` right from your collaboration workspace. Collaborate with other team members in real time. -Botkube supports literally any Kubernetes resource, including Custom Resources. For example, if you use [`cert-manager`](https://cert-manager.io/), you can get alerted about certificate issue, or backup failure in case you use backup tools like [Velero](https://velero.io/) or [Kanister](https://kanister.io/). +### 📖 Wait, there's more! -

+Read more about Botkube features on [the official website](https://botkube.io/features/). - - -### Debug anywhere, anytime - -Using Botkube you can debug your apps deployed on Kubernetes from anywhere. To extract crucial information from the cluster, you can even use mobile communicator apps, like Slack. The entire team can see what steps have already been taken and avoid duplicated work. - -

- - - -### Deploy on any Kubernetes cluster +## Documentation -You can deploy Botkube backend on any Kubernetes cluster. It doesn't matter whether it is [K3d](https://k3d.io), managed Kubernetes on a cloud provider, or bare-metal one. +For full documentation, visit [docs,botkube.io](https://docs.botkube.io). The documentation sources reside on the [botkube-docs](https://github.com/kubeshop/botkube-docs) repository. ## Licence diff --git a/docs/assets/icons/bug-line.svg b/docs/assets/icons/bug-line.svg deleted file mode 100644 index 19cc995e9..000000000 --- a/docs/assets/icons/bug-line.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/assets/icons/cloud-line.svg b/docs/assets/icons/cloud-line.svg deleted file mode 100644 index ea853fefa..000000000 --- a/docs/assets/icons/cloud-line.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/assets/icons/question-answer-line.svg b/docs/assets/icons/question-answer-line.svg deleted file mode 100644 index 29bc68995..000000000 --- a/docs/assets/icons/question-answer-line.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/assets/icons/stack-line.svg b/docs/assets/icons/stack-line.svg deleted file mode 100644 index 1bd316f6a..000000000 --- a/docs/assets/icons/stack-line.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/assets/icons/terminal-box-line.svg b/docs/assets/icons/terminal-box-line.svg deleted file mode 100644 index 594c5296b..000000000 --- a/docs/assets/icons/terminal-box-line.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file