github/kubescape
1
0
Fork 0
mirror of https://github.com/kubescape/kubescape.git synced 2026-04-15 06:58:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Revamp documentation and reduce host sensor workers

Browse Source 
Signed-off-by: Matthias Bertschy <matthias.bertschy@gmail.com>
This commit is contained in:
Matthias Bertschy
2025-11-28 19:01:25 +01:00
parent acc9b54b2b
commit b6a4e282f9
15 changed files with 4040 additions and 398 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
docs/README.md Normal file
View File

@@ -0,0 +1,97 @@
# Kubescape Documentation
Welcome to the Kubescape documentation. This directory contains detailed guides and references for using Kubescape.
[![Docs](https://img.shields.io/badge/docs-latest-brightgreen?logo=gitbook)](https://kubescape.io/docs/)
[![GitHub](https://img.shields.io/github/license/kubescape/kubescape)](https://github.com/kubescape/kubescape/blob/master/LICENSE)
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/kubescape/project-governance/blob/main/CONTRIBUTING.md)
## 📚 Documentation Index
### Getting Started
| Document | Description |
|----------|-------------|
| [Installation Guide](installation.md) | How to install Kubescape on various platforms |
| [Getting Started](getting-started.md) | First steps with Kubescape, basic usage examples |
### Reference
| Document | Description |
|----------|-------------|
| [CLI Reference](cli-reference.md) | Complete command-line reference for all Kubescape commands |
| [Architecture](architecture.md) | Technical architecture of Kubescape CLI and Operator |
### Features
| Document | Description |
|----------|-------------|
| [MCP Server](mcp-server.md) | AI assistant integration via Model Context Protocol |
| [Providers](providers.md) | Backend services compatible with Kubescape |
### Support
| Document | Description |
|----------|-------------|
| [Troubleshooting](troubleshooting.md) | Common issues and solutions |
### Additional Resources
| Document | Description |
|----------|-------------|
| [Environment Dependencies Policy](environment-dependencies-policy.md) | Policy on external dependencies |
| [Roadmap](roadmap.md) | Project roadmap (see centralized governance repo) |
## 📁 Subdirectories
| Directory | Description |
|-----------|-------------|
| [img/](img/) | Images and diagrams used in documentation |
| [proposals/](proposals/) | Design proposals and RFCs |
| [providers/](providers/) | Provider-specific documentation |
## 🔗 External Documentation
- **[Kubescape Website](https://kubescape.io)** - Official website with additional guides
- **[Kubescape Docs Hub](https://kubescape.io/docs/)** - Comprehensive online documentation
- **[Controls Reference](https://kubescape.io/docs/controls/)** - List of all security controls
- **[Helm Charts](https://github.com/kubescape/helm-charts)** - Operator installation
- **[Regolibrary](https://github.com/kubescape/regolibrary)** - Security controls library
## 🤝 Contributing to Documentation
We welcome contributions to improve our documentation! Please see the [Contributing Guide](https://github.com/kubescape/project-governance/blob/main/CONTRIBUTING.md) for details.
### Documentation Style
- Use clear, concise language
- Include code examples where applicable
- Keep command examples copy-pasteable
- Update the table of contents when adding sections
- Test all commands before documenting them
## 📝 Document Status
| Document | Status | Description |
|----------|--------|-------------|
| [installation.md](installation.md) | ✅ Current | Installation methods for all platforms |
| [getting-started.md](getting-started.md) | ✅ Current | Quick start and usage examples |
| [cli-reference.md](cli-reference.md) | ✅ Current | Complete CLI command reference |
| [architecture.md](architecture.md) | ✅ Current | Technical architecture documentation |
| [mcp-server.md](mcp-server.md) | ✅ Current | AI assistant integration (MCP) |
| [troubleshooting.md](troubleshooting.md) | ✅ Current | Common issues and solutions |
| [providers.md](providers.md) | ✅ Current | Backend service providers |
| [environment-dependencies-policy.md](environment-dependencies-policy.md) | ✅ Current | Dependency policies |
---
## 📖 Quick Links
| I want to... | Go to... |
|--------------|----------|
| Install Kubescape | [Installation Guide](installation.md) |
| Run my first scan | [Getting Started](getting-started.md#run-your-first-scan) |
| See all CLI options | [CLI Reference](cli-reference.md) |
| Use Kubescape with AI assistants | [MCP Server](mcp-server.md) |
| Fix a problem | [Troubleshooting](troubleshooting.md) |
| Understand the architecture | [Architecture](architecture.md) |