docs: improve the kubeFleet landing page and add community meeting info #67

ryanzhang-oss · 2025-05-19T21:06:46Z

Description of your changes

improve the kubeFleet landing page and add community meeting info.

Fixes #

I have:

Run make reviewable to ensure this PR is ready for review.

How has this code been tested

Special notes for your reviewer

Copilot

Pull Request Overview

Enhance the KubeFleet README by reorganizing introductory content, adding quickstart and community meeting details, and updating links and badges.

Introduce a “What is KubeFleet?” section and refine the project overview.
Add Quickstart instructions and Community sections including bi-weekly meeting information.
Update badge URLs to point at the correct kubefleet-dev/kubefleet repository.

README.md

Copilot

Pull Request Overview

Enhance the README with a clearer project introduction, updated community links, and added community meeting details

Introduce “What is KubeFleet?”, Quickstart, and Documentation sections
Add Community and Community Meetings information with calendar and recordings links
Update repository badges and consolidate Code of Conduct section

README.md

Copilot

Pull Request Overview

This PR improves the KubeFleet landing page documentation by adding detailed community and meeting information, and it refines error handling for concurrent updateRuns in the updaterun controller.

Enhanced error handling in pkg/controllers/updaterun/execution.go to better address concurrency issues.
Updated README.md to provide clearer information about KubeFleet features and added links for community engagement.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
pkg/controllers/updaterun/execution.go	Refactored error handling logic for concurrent updateRuns with improved logging and variable usage.
README.md	Revised landing page content and added community meeting info, with updated link references.

Comments suppressed due to low confidence (1)

pkg/controllers/updaterun/execution.go:178

Consider including the updateRun identifier or additional context in the error message to more clearly indicate the cause of preemption due to concurrent updates, which can help in debugging.

preemptedErr := controller.NewUserError(fmt.Errorf("the clusterResourceBinding of the updating cluster `%s` in the stage `%s` is not up-to-date with the desired status, please check the status of binding `%s` and see if there is a concurrent updateRun referencing the same clusterResourcePlacement and updating the same cluster", clusterStatus.ClusterName, updatingStageStatus.StageName, klog.KObj(binding)))

Copilot · 2025-05-19T21:37:55Z

README.md

+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) 


Remove the extra space between the closing bracket and the opening parenthesis in the Slack link so that the markdown renders correctly.

codecov · 2025-05-19T21:53:06Z

Codecov Report

Attention: Patch coverage is 64.66877% with 112 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
apis/placement/v1beta1/zz_generated.deepcopy.go	0.00%	44 Missing ⚠️
pkg/controllers/workgenerator/controller.go	43.54%	29 Missing and 6 partials ⚠️
pkg/controllers/workgenerator/envelope.go	89.18%	15 Missing and 1 partial ⚠️
apis/placement/v1beta1/envelope_types.go	33.33%	12 Missing ⚠️
...lers/clusterresourceplacement/resource_selector.go	0.00%	5 Missing ⚠️

📢 Thoughts on this report? Let us know!

README.md

michaelawyu · 2025-05-20T06:05:04Z

README.md

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


Hi Ryan! I think the duplicate the issue re-appears somehow

Same to a lot of the raised issues... Is there something wrong on my end?

fixed, do you see more duplicates?

README.md

Signed-off-by: michaelawyu <[email protected]> Signed-off-by: Ryan Zhang <[email protected]> Co-authored-by: Ryan Zhang <[email protected]> Signed-off-by: Ryan Zhang <[email protected]>

…ate (kubefleet-dev#63) Signed-off-by: Ryan Zhang <[email protected]>

Signed-off-by: Ryan Zhang <[email protected]>

…et-dev#61) Signed-off-by: Ryan Zhang <[email protected]>

Signed-off-by: Ryan Zhang <[email protected]>

Co-authored-by: Copilot <[email protected]> Co-authored-by: Britania Rodriguez Reyes <[email protected]> Signed-off-by: Ryan Zhang <[email protected]>

Copilot

Pull Request Overview

Improve the KubeFleet README by restructuring key sections, updating badge links, and adding community meeting information.

Restructured landing page sections (What is KubeFleet, Quickstart, Documentation, Community, Meetings)
Added bi-weekly community meeting details and relevant links
Updated repository references for badges

Comments suppressed due to low confidence (1)

README.md:58

The Codecov badge still references Azure/fleet; update it to kubefleet-dev/kubefleet so it points to the current repository.

[4]:  https://codecov.io/gh/Azure/fleet/branch/main/graph/badge.svg?token=D3mtbzACjC

Copilot · 2025-05-20T18:36:45Z

README.md

+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) 


[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 · 2025-05-20T18:36:45Z

README.md

+
+* Q & A: [GitHub Discussions](https://github.com/kubefleet-dev/kubefleet/discussions)
+* Slack: [The #KubeFleet Slack channel](https://cloud-native.slack.com/archives/C08KR7589R8) 
+* Mailing list: [mailing list](https://groups.google.com/g/kubefleet-dev)


[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)

…fo (kubefleet-dev#67)

ryanzhang-oss requested a review from Copilot May 19, 2025 21:06

Copilot AI reviewed May 19, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

ryanzhang-oss requested a review from Copilot May 19, 2025 21:08

ryanzhang-oss changed the title ~~doc: improve the kubeFleet landing page and add community meeting info~~ docs: improve the kubeFleet landing page and add community meeting info May 19, 2025

Copilot AI reviewed May 19, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

ryanzhang-oss force-pushed the add-meeting-detaisl branch from 84cfa1d to e1ba1e9 Compare May 19, 2025 21:32

ryanzhang-oss requested a review from Copilot May 19, 2025 21:37

Copilot AI reviewed May 19, 2025

View reviewed changes

britaniar reviewed May 19, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

britaniar previously approved these changes May 20, 2025

View reviewed changes

ryanzhang-oss dismissed britaniar’s stale review via cea8e1d May 20, 2025 00:12

ryanzhang-oss force-pushed the add-meeting-detaisl branch from 8587ac6 to cea8e1d Compare May 20, 2025 00:12

michaelawyu reviewed May 20, 2025

View reviewed changes

README.md Show resolved Hide resolved

michaelawyu and others added 8 commits May 20, 2025 11:33

feat: enable new CR-based envelope experience (kubefleet-dev#38)

b1a73e0

Signed-off-by: michaelawyu <[email protected]> Signed-off-by: Ryan Zhang <[email protected]> Co-authored-by: Ryan Zhang <[email protected]> Signed-off-by: Ryan Zhang <[email protected]>

fix: fix updateRun error msg when a binding does not have expected st…

e11387c

…ate (kubefleet-dev#63) Signed-off-by: Ryan Zhang <[email protected]>

improve the kubeFleet landing page and add community meeting info

882abd4

Signed-off-by: Ryan Zhang <[email protected]>

minor fix

f8d0272

Signed-off-by: Ryan Zhang <[email protected]>

fix linke

2e7a693

Signed-off-by: Ryan Zhang <[email protected]>

feat: add validator functions for eviction to use in webhook (kubefle…

c70b2c8

…et-dev#61) Signed-off-by: Ryan Zhang <[email protected]>

fix typo

8507016

Signed-off-by: Ryan Zhang <[email protected]>

Apply suggestions from code review

f7be0f7

Co-authored-by: Copilot <[email protected]> Co-authored-by: Britania Rodriguez Reyes <[email protected]> Signed-off-by: Ryan Zhang <[email protected]>

ryanzhang-oss force-pushed the add-meeting-detaisl branch from b7f3d59 to f7be0f7 Compare May 20, 2025 18:33

Merge branch 'main' into add-meeting-detaisl

ed46756

ryanzhang-oss requested a review from Copilot May 20, 2025 18:35

britaniar approved these changes May 20, 2025

View reviewed changes

Copilot AI reviewed May 20, 2025

View reviewed changes

ryanzhang-oss merged commit d9e0d1b into kubefleet-dev:main May 20, 2025
6 checks passed

audrastump pushed a commit to audrastump/kubefleet that referenced this pull request Aug 20, 2025

docs: improve the kubeFleet landing page and add community meeting in…

d6d4f35

…fo (kubefleet-dev#67)


		## Documentation

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

	* 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.

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

docs: improve the kubeFleet landing page and add community meeting info #67

docs: improve the kubeFleet landing page and add community meeting info #67

Uh oh!

Conversation

ryanzhang-oss commented May 19, 2025

Description of your changes

How has this code been tested

Special notes for your reviewer

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 19, 2025

Choose a reason for hiding this comment

Uh oh!

codecov bot commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

michaelawyu May 20, 2025

Choose a reason for hiding this comment

Uh oh!

michaelawyu May 20, 2025

Choose a reason for hiding this comment

Uh oh!

ryanzhang-oss May 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI May 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented May 19, 2025 •

edited

Loading