KubeStellar Documentation

<p align="center"> <img src="./public/KubeStellar-with-Logo-transparent.png" alt="KubeStellar Logo" width="500"/> </p> <h2 align="center">Multi-cluster Configuration Management for Edge, Multi-Cloud, and Hybrid Cloud</h2> <p align="center"> Official documentation repository for <strong><a href="https://kubestellar.io" target="_blank">KubeStellar</a></strong>, a CNCF Sandbox Project enabling seamless multi-cluster configuration management for edge, multi-cloud and hybrid cloud environments. </p> <p align="center"> <a href="https://cloud-native.slack.com/archives/C097094RZ3M" target="_blank"> <img alt="Join Slack" src="https://img.shields.io/badge/KubeStellar-Join%20Slack-blue?logo=slack"/> </a>   <a href="https://deepwiki.com/kubestellar/ui" target="_blank"> <img alt="Ask DeepWiki" src="https://deepwiki.com/badge.svg"/> </a> </p>

KubeStellar Docs Website

All docs for KubeStellar and its component products are now consolidated in this repository to render a consolidated website. Visit the website at: https://kubestellar.io/

Website preview for a PR ###: https://deploy-preview-###--kubestellar-docs.netlify.app

Overview

KubeStellar simplifies Kubernetes operations across distributed infrastructure by providing powerful multi-cluster configuration management capabilities. This repository serves as the canonical source for all KubeStellar documentation, powering the official documentation website at <a href="https://kubestellar.io" target="_blank">kubestellar.io</a>.

Key Features

Flexible Binding Policies — Define sophisticated relationships between clusters and Kubernetes resources
Familiar Tooling — Leverage existing single-cluster tools and workflows for multi-cluster operations
Enhanced Operations — Improve compliance, resilience, availability, and developer productivity across your infrastructure

Documentation Content

This repository includes comprehensive documentation such as:

Getting Started Guides — Quick start workflows and installation instructions
User & Operator Guides — Detailed operational documentation
Architecture & Technical References — In-depth design specifications
API Documentation — Complete API reference materials
Roadmaps & Release Notes — Project planning and version history
Contribution Guidelines — Resources for contributors and maintainers
Real-World Examples — Practical use cases and hands-on tutorials

Local Development

This documentation site is built with Nextra — a Next.js-based static site generator optimized for documentation. The site uses:

Nextra - Documentation framework with MDX support
Next.js 15 - React framework for production
Tailwind CSS - Utility-first styling
TypeScript - Type-safe development

Prerequisites

Node.js v18.0.0 or higher (Download)
npm or yarn package manager

Verify your Node.js installation:

node --version

Setup Instructions

Clone the repository:

git clone https://github.com/kubestellar/docs.git
cd docs

Install dependencies:
```
npm install
# or
yarn install
```
Start the development server:
```
npm run dev
# or
yarn dev
```
The site will be available at http://localhost:3000 with hot-reload enabled for instant feedback.
Build for production:
```
npm run build
# or
yarn build
```
Preview the production build:
```
npm start
# or
yarn start
```

Community & Support

We welcome contributions and engagement from the community. Here's how to get involved:

Communication Channels

Slack: Join #kubestellar-dev in the CNCF Slack Workspace
Mailing Lists:
- kubestellar-dev — Development discussions
- kubestellar-users — User community discussions
Community Meetings: Subscribe to our community calendar
- Automatically subscribed via the kubestellar-dev mailing list
Meeting Recordings: Available on YouTube
Meeting Notes: View upcoming and past agendas

Additional Resources

Shared Documents: Access our Google Drive for design docs and collaborative materials
- Available to kubestellar-dev mailing list members
Blog: Read our latest updates on Medium
LinkedIn: Follow KubeStellar on LinkedIn for news and updates

Contributing

We welcome contributions of all kinds — from documentation improvements to code contributions. Please review our Contributing Guide to get started.

Areas for Contribution

Documentation improvements and corrections
Tutorial and example development
Translation and localization
Code contributions to the core project
Community support and engagement

<h2 align="left"> <img src="https://raw.githubusercontent.com/Tarikul-Islam-Anik/Animated-Fluent-Emojis/master/Emojis/Smilies/Red%20Heart.png" alt="Red Heart" width="40" height="40" /> Contributors </h2> <p align="center"> <a href="https://github.com/kubestellar/docs/graphs/contributors"> <img src="https://contrib.rocks/image?repo=kubestellar/docs" alt="Contributors"/> </a> </p>

CNCF Sandbox Project

KubeStellar is a Cloud Native Computing Foundation Sandbox project, part of the broader cloud native ecosystem working to make cloud native computing universal and sustainable.

Docs

Install / Use

README