Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.23 KB

README.md

File metadata and controls

36 lines (24 loc) · 1.23 KB
Raw

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 framework first. The different directories in the documentation correspond to sections explored in the framework.

The contribution guidelines to the documentation are the same as for the main project: K8sGPT contributing guidelines