Skip to content
45 changes: 33 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,52 @@
KubeFleet is a sandbox project of the [Cloud Native Computing Foundation](https://cncf.io/) (CNCF) that works on any Kubernetes cluster.
We are working towards the vision where we will eventually be able to treat each Kubernetes cluster as a [cattle](https://cloudscaling.com/blog/cloud-computing/the-history-of-pets-vs-cattle/).

## What is KubeFleet?
KubeFleet contains a set of Kubernetes controllers and CRDs which provide an advanced cloud-native solution for multi-cluster application management.

## Code of Conduct
Use KubeFleet to schedule workloads smartly, roll out changes progressively, and perform administrative tasks easily, across a group of Kubernetes clusters on any cloud or on-premises clusters.

This project has adopted the [CNCF Open Source Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). See the [Code of Conduct](CODE_OF_CONDUCT.md) for more information.

## Contributing
## Quickstart

The [contribution guide](CONTRIBUTING.md) covers everything you need to know about how you can contribute to KubeFleet.
* [Get started here](https://kubefleet-dev.github.io/website/docs/getting-started/kind/)

## Support
For more information, see [SUPPORT.md](SUPPORT.md).
## Documentation

To learn more about KubeFleet go to the [KubeFleet documentation](https://kubefleet-dev.github.io/website/).

## Community

You can reach the KubeFleet community and developers via the following channels:

* Q & A: [GitHub Discussions](https://github.com/kubefleet-dev/kubefleet/discussions)
* Slack: [The #KubeFleet Slack channel](https://cloud-native.slack.com/archives/C08KR7589R8)
Copy link

Copilot AI May 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The Slack link points to an internal workspace; consider providing the public join link (e.g., via slack.cncf.io) or instructions so new contributors can easily join.

Suggested change
* Slack: [The #KubeFleet Slack channel](https://cloud-native.slack.com/archives/C08KR7589R8)
* Slack: Join the [KubeFleet Slack workspace](https://slack.cncf.io) and navigate to the `#KubeFleet` channel to connect with the community.

Copilot uses AI. Check for mistakes.
* Mailing list: [mailing list](https://groups.google.com/g/kubefleet-dev)
Copy link

Copilot AI May 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The link text 'mailing list' is generic; consider changing it to 'KubeFleet mailing list' to make the purpose clear at first glance.

Suggested change
* Mailing list: [mailing list](https://groups.google.com/g/kubefleet-dev)
* Mailing list: [KubeFleet mailing list](https://groups.google.com/g/kubefleet-dev)

Copilot uses AI. Check for mistakes.

## Community Meetings

## Contact
We host bi-weekly community meetings that alternate between US/EU and APAC friendly time. In these sessions the community will showcase demos and discuss the current and future state of the project.

If you have questions, feel free to reach out to us in the following ways:
Please refer to the [KubeFleet CNCF meeting calendar](https://zoom-lfx.platform.linuxfoundation.org/meetings/kubefleet?view=month) for the latest schedule.

- [mailing list](https://groups.google.com/g/kubefleet-dev)
- [slack](https://cloud-native.slack.com/archives/C08KR7589R8) | [Join](https://slack.cncf.io/)
For more meeting information, minutes and recordings, please see the [KubeFleet community meeting doc](https://docs.google.com/document/d/1iMcHn11fPlb9ZGoMHiGEBvdIc44W1CjZvsPH3eBg6pA/edit?usp=sharing).

## Code of Conduct
Participation in KubeFleet is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). See the [Code of Conduct](CODE_OF_CONDUCT.md) for more information.

## Contributing

The [contribution guide](CONTRIBUTING.md) covers everything you need to know about how you can contribute to KubeFleet.

## Support
For more information, see [SUPPORT](SUPPORT.md).


[1]: https://img.shields.io/github/v/release/Azure/fleet
[1]: https://img.shields.io/github/v/release/kubefleet-dev/kubefleet
[2]: https://goreportcard.com/badge/go.goms.io/fleet
[3]: https://goreportcard.com/report/go.goms.io/fleet
[4]: https://codecov.io/gh/Azure/fleet/branch/main/graph/badge.svg?token=D3mtbzACjC
[5]: https://img.shields.io/github/go-mod/go-version/Azure/fleet
[5]: https://img.shields.io/github/go-mod/go-version/kubefleet-dev/kubefleet

Copyright The KubeFleet Authors.
The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/trademark-usage/).