thschue / k8sgpt-docs

Documentation for K8sGPT

K8sGPT Documentation

K8sGPT gives Kubernetes SRE superpowers to everyone

The documentation provides the following

• Getting started: Guides to install and use K8sGPT
• Tutorials: End-to-end tutorials on specific use cases
• Reference: Specific documentation on the features
• Explanation: Additional explanations on the design and use of the CLI

Documentation enhancements

If anything is unclear please create an issue in the docs repository.

Running the documentation locally

Prerequisites

• Docker installed and running

Clone the repository

git clone [email protected]:k8sgpt-ai/docs.git

And then from within the docs repository, you can start the development server:

make mkdocs-serve

Contributing

This documentation follows the Diataxis framework. If you are proposing completely new content to the documentation, please familiarise yourself with the framwork first.