fix: make ClusterProperty easier to understand with clearer usage and lifecycle context #42
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for kubernetes-sig-multicluster ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: kahirokunn The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/L
kahirokunn
force-pushed
the
improve-about-api-docs
branch
from
3855ba7 to
2e20003
Compare
k8s-ci-robot
added
size/M
…and lifecycle explanations Signed-off-by: kahirokunn <[email protected]>
kahirokunn
force-pushed
the
improve-about-api-docs
branch
from
2e20003 to
f2a0ae2
Compare
kahirokunn
changed the title
Contributor
|
/sig multicluster |
k8s-ci-robot
added
the
sig/multicluster
|
The Kubernetes project currently lacks enough contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
k8s-ci-robot
added
the
lifecycle/stale
Member
Author
|
/remove-lifecycle stale |
k8s-ci-robot
removed
the
lifecycle/stale
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The original ClusterProperty documentation was hard to follow and left some key
questions unanswered, such as where the custom resource should be placed, how it
actually ties to a cluster, and what is explicitly defined versus left
unspecified.
For me, this meant that even though I understood ClusterProperty could identify
a cluster, I struggled to grasp its lifecycle and practical usage without
digging into the KEP directly.
This PR expands the documentation with lifecycle rules, constraints, use cases,
and operational guidance, so readers can build an intuitive understanding of
ClusterProperty without having to cross-reference the KEP.
I hope this helps others who may run into the same confusion and need a more
practical, approachable explanation.
Unlike the exhaustive and formal style of the KEP, this documentation focuses
on clarity and practical understanding, so that readers can quickly grasp what
ClusterProperty is and how to use it.