Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/k8sgpt-ai/docs
Documentation for K8sGPT
https://github.com/k8sgpt-ai/docs
ai chatgpt docs kubernetes sre
Last synced: 2 days ago
JSON representation
Documentation for K8sGPT
- Host: GitHub
- URL: https://github.com/k8sgpt-ai/docs
- Owner: k8sgpt-ai
- License: apache-2.0
- Created: 2023-03-30T09:42:10.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-16T14:21:31.000Z (about 2 months ago)
- Last Synced: 2025-01-23T00:07:10.075Z (10 days ago)
- Topics: ai, chatgpt, docs, kubernetes, sre
- Language: Makefile
- Homepage: https://docs.k8sgpt.ai/
- Size: 1.93 MB
- Stars: 37
- Watchers: 1
- Forks: 48
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.](https://github.com/k8sgpt-ai/docs)
## Running the documentation locally
**Prerequisites**
* Docker installed and running
Clone the repository
```bash
git clone [email protected]:k8sgpt-ai/docs.git
```
And then from within the docs repository, you can start the development server:
```bash
make mkdocs-serve
```
## Contributing
This documentation follows the [Diataxis](https://diataxis.fr/) 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](https://github.com/k8sgpt-ai/k8sgpt/blob/main/CONTRIBUTING.md)