KubeStellar Documentation

Multi-cluster Configuration Management for Edge, Multi-Cloud, and Hybrid Cloud
Official documentation source for the KubeStellar Website.

---

🚀 About KubeStellar

KubeStellar is a CNCF Sandbox Project that enables seamless deployment and configuration of Kubernetes objects across multiple clusters — whether you're operating in edge, multi-cloud, or hybrid environments.

KubeStellar lets you:

• Define binding policies between clusters and Kubernetes resources
• Use familiar single-cluster tooling for multi-cluster operations
• Improve compliance, resilience, availability, and developer productivity

Learn more at the official KubeStellar Website.

---

📘 Purpose of This Repository

This repository powers the KubeStellar Documentation Site, serving as the canonical source for:

• User & operator guides
• Architecture overviews
• Roadmaps and release notes
• Contribution and governance documentation
• Tutorials and examples

We aim to deliver well-organized, consistent, and comprehensive documentation to help both new users and experienced contributors.

---

🗺️ Key Resources

• 🔗 Main Site: https://kubestellar.io
• 📄 Roadmap: docs/content/direct/roadmap.md
• 🧑‍💻 Contributing: CONTRIBUTING.md
• 📜 Code of Conduct: CODE_OF_CONDUCT.md
• 📅 Join us: http://kubestellar.io/joinus

---

🛠️ Local Development (Next.js)

Follow these steps to set up and run the Next.js site locally:

1. Ensure you have Node.js v18+ installed. Confirm with:

   node --version

2. Install dependencies:

   npm install

   or with Yarn:

   yarn

3. Start the development server:

   npm run dev

   Visit http://localhost:3000 in your browser. The server supports hot-reload.

4. Build the production bundle:

   npm run build

5. (Optional) Preview the production build locally:

   npm start

---

👥 Community & Communication

• 💬 Slack: #kubestellar-dev (Join via slack.k8s.io)
• 📧 Mailing Lists:
  • kubestellar-dev
  • kubestellar-users
• 🗓️ Community Calendar
• 📺 Community Meetings on YouTube
• 🧾 Meeting Agendas & Notes
• 📂 Shared Google Drive
• 📣 Follow us:
  • LinkedIn
  • Medium

---

🤝 How to Contribute

We welcome all contributors! Whether you're fixing a typo or writing new docs, your help makes a big impact.

• Review our Contributing Guidelines
• Join discussions on Slack or our mailing lists
• Open issues or PRs for any documentation improvements

---

📊 Project Badges & Compliance

---

🧠 Maintainers & Contributors

---

🌐 CNCF & Licensing

We are a proud Cloud Native Computing Foundation Sandbox Project.

Kubernetes® and the Kubernetes logo are registered trademarks of The Linux Foundation®.
© 2022–2025 The KubeStellar Authors. All rights reserved.
Licensed under the Apache License 2.0.