dLobatog / botkube-docs

Docs for https://github.com/infracloudio/botkube

BotKube

For complete documentation visit www.botkube.io

A slack bot which keeps eye on your Kubernetes resources and notifies about resources life cycles events, errors and warnings. It allows you to define and run certain checks on resources specs. You can also ask BotKube to execute kubectl commands on Kubernetes cluster which helps debugging an application or cluster.

Contributing

This website uses Hugo to generate static HTML pages. It's hosted and automatically build by Netlify (see netlify.toml for more details).

• content/ directory contains documentation files
• config.toml is the Hugo configuration
• netlify.toml is Netlify configuration

Build the site locally

Make sure you have installed Hugo on your system. Follow the instructions to clone this repository and build the docs locally.

• Clone the repository

  git clone https://github.com/infracloudio/botkube-docs
  cd botkube-docs

• Fetch the theme submodule

  git submodule update --init --recursive

• Start local server

  hugo serve -D

  Site can be viewed at http://localhost:1313

Making changes

Adding a new documentation page

# example: adding new documentation page under installation section
hugo new installation/name-of-new-integration.md

Modifying an existing documentation page

Find the documentation page file (.md file) under content/ and edit it.

Publishing your changes

Create a Pull Request with your changes. When the PR is merged site will be updated automatically by Netlify.

Licensing

The code snippets and the documentation is licensed under MIT license. BotKube name and the logo are copyright of InfraCloud Technologies. See LICENSE for the full license text.