Welcome to the official Devtron Documentation Repository This repo hosts the complete documentation for installing, using, and managing Devtron, an open-source software delivery platform built on Kubernetes.
Devtron is an open-source Kubernetes-native software delivery platform that simplifies complex CI/CD, infrastructure, and release management workflows.
It provides:
- Unified dashboards for build, deploy, and monitoring
- GitOps-driven deployment (powered by ArgoCD)
- AI-powered debugging and recommendations
- Built-in vulnerability scanning
- Plugin ecosystem for extensibility
- Cluster and cost visibility
- Role-based access control (RBAC) and SSO integrations
With Devtron, teams can deploy and manage applications across multiple environments without the steep Kubernetes learning curve.
This repository powers the Devtron Docs site using Docusaurus v3.
It contains all documentation files, categorized and rendered as website pages.
| Path | Description |
|---|---|
/docs/ |
Main documentation directory containing Markdown (.md) and MDX files. |
/docs/setup/ |
Installation and configuration guides. |
/docs/user-guide/ |
Core user guides including Application Management, Infra, Policies, etc. |
/docs/reference/ |
FAQs, troubleshooting, and glossaries. |
/static/ |
Static assets such as images and icons. |
/sidebars.js |
Defines documentation hierarchy and navigation structure. |
/docusaurus.config.js |
Core site configuration including theme and plugins. |
/src/ |
Contains React components, layouts, and theme overrides. |
The documentation follows a structured hierarchy defined in sidebars.js:
| Section | Purpose |
|---|---|
| Getting Started | Onboarding and installation instructions for new users. |
| Application Management | Creating, configuring, and managing applications in Devtron. |
| Infrastructure Management | Managing clusters, resources, and node-level operations. |
| Software Release Management | Handling multi-tenant releases and deployment visibility. |
| Cost Visibility | Insights into FinOps capabilities of Devtron. |
| Security | Insights into security scanning and policies. |
| Automation & Enablement | Job automation, task configuration, and workflow management. |
| AI Recommendations | Features powered by Devtron’s AI system. |
| Global Configurations | Managing host URL, GitOps, SSO, permissions, and global policies. |
| Resources | References, integrations, upgrades, and use cases. |
Each folder contains a README.md file that serves as an index page and links to nested topics.
- Node.js ≥ 18.x
- npm or Yarn or
# Clone the repo
git clone https://github.com/devtron-labs/devtron-documentation.git
cd devtron-docs
# Install dependencies
npm install
# or
yarn installnpm run start
# or
yarn startYour site will be available at 👉 http://localhost:3000
To generate an optimized static build resembling production behavior:
npm run build
# or
yarn buildThis will create a production-ready site in the /build directory. Use the following command to access it:
npm run serve
# or
yarn serveYour site will be available at 👉 http://localhost:3000
We welcome contributions from both internal as well as external contributors.
Whether it’s fixing typos, improving clarity, or adding new guides, your help makes our documentation better.
- Fork this repository
- Create a branch (
git checkout -b feature/add-new-guide) - Make your changes
- Commit and push
- Open a Pull Request (PR) to the
mainbranch
- Use clear, concise language
- Use title case for titles and headings.
- Prefer active voice (e.g., “Click Deploy” instead of “The button should be clicked”)
- Use fenced code blocks for commands or YAML
- Use Docusaurus admonitions (
:::tip,:::warning, etc.) for emphasis - Keep paragraphs short and scannable
This repository is licensed under the Apache 2.0 License.
See the LICENSE file for more details.