Skip to content

Add overview to ChaosCenter Developer Guide documentation #360

@PriteshKiri

Description

@PriteshKiri

Description
The ChaosCenter Developer Guide currently lacks an overview section. Adding an introductory overview will help developers understand the purpose, architecture, and scope of the guide before diving into setup and usage instructions.

Location
website/docs/developer-guide/chaoscenter-developer-guide.md → At the beginning of the document

Proposed changes
• Add a new Overview at the top of the guide with the following content:

ChaosCenter is the control plane for LitmusChaos, providing a web-based interface and APIs to manage chaos experiments on Kubernetes clusters. It consists of a backend (GraphQL server, Authentication server, MongoDB) and a frontend (React) component. This guide walks you through setting up ChaosCenter locally, running the required services, and connecting your Kubernetes infrastructure to execute and monitor chaos experiments.

The document assumes a local development environment and is not recommended for production or shared clusters. By the end of this guide, you will have a fully functional ChaosCenter instance capable of managing chaos workflows and integrating with Litmusctl or ChaosCenter-managed infrastructures.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions