Code Monkey home page Code Monkey logo

docs's Introduction

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

docs's People

Contributors

anaisurlichs avatar alexsjones avatar rakshitgondwal avatar thschue avatar camigira avatar matthisholleville avatar cubxxw avatar bradmccoydev avatar kaiwalyakoparkar avatar drpaneas avatar tylergillson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.