🌱 Fix grammer, spell, and punctuation issues in api description. #318
Conversation
|
/assign @oafisher |
|
@xuezhaojun: GitHub didn't allow me to assign the following users: oafisher. Note that only open-cluster-management-io members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
addon/v1alpha1/0000_00_addon.open-cluster-management.io_clustermanagementaddons.crd.yaml
Outdated
Show resolved
Hide resolved
xuezhaojun
force-pushed
the
improve-descriptions
branch
from
a1b888e
to
d9de97e
Compare
| @@ -19,11 +19,11 @@ spec: | |||
| schema: | |||
| openAPIV3Schema: | |||
| description: ManagedClusterSetBinding projects a ManagedClusterSet into a | |||
There was a problem hiding this comment.
Suggestion: ManagedClusterSetBinding projects a ManagedClusterSet into a
certain namespace. You can create a ManagedClusterSetBinding in
a namespace and bind it to a ManagedClusterSet if both have a RBAC rules
to CREATE on the virtual subresource of managedclustersets/bind. Workloads
that you create in the same namespace can only be distributed to ManagedClusters
in ManagedClusterSets that are bound in this namespace by higher-level controllers.
| description: "ManagedClusterSet defines a group of ManagedClusters that user's | ||
| workload can run on. A workload can be defined to deployed on a ManagedClusterSet, | ||
| which mean: 1. The workload can run on any ManagedCluster in the ManagedClusterSet | ||
| description: "ManagedClusterSet defines a group of ManagedClusters that users' |
There was a problem hiding this comment.
Suggestion: "ManagedClusterSet defines a group of ManagedClusters that you can run
workloads on. You can define a workload to be deployed on a ManagedClusterSet. See the following options for the workload:
- The workload can run on any ManagedCluster in the ManagedClusterSet
- The workload cannot run on any ManagedCluster outside the ManagedClusterSet
- The service exposed by the workload can be shared in any ManagedCluster
in the ManagedClusterSet \n To assign a ManagedCluster to a certain
ManagedClusterSet, add a label with the name cluster.open-cluster-management.io/clusterset
on the ManagedCluster to refer to the ManagedClusterSet. You are not
allowed to add or remove this label on a ManagedCluster unless you have an
RBAC rule to CREATE on a virtual subresource of managedclustersets/join.
To update this label, you must have the permission on both
the old and new ManagedClusterSet."
| @@ -15,14 +15,14 @@ spec: | |||
| - name: v1beta1 | |||
| schema: | |||
| openAPIV3Schema: | |||
| description: "PlacementDecision indicates a decision from a placement PlacementDecision | |||
| should has a label cluster.open-cluster-management.io/placement={placement | |||
| description: "PlacementDecision indicates a decision from a placement. PlacementDecision | |||
There was a problem hiding this comment.
Suggestion: "PlacementDecision indicates a decision from a placement. PlacementDecision
must have a cluster.open-cluster-management.io/placement={placement name} label to reference a certain placement. \n If a placement has spec.numberOfClusters
specified, the total number of decisions contained in the status.decisions
of PlacementDecisions must be the same as NumberOfClusters. Otherwise, the
total number of decisions must equal the number of ManagedClusters that
match the placement requirements. \n Some of the decisions might be empty
when there are not enough ManagedClusters to meet the placement requirements."
| @@ -35,14 +35,15 @@ spec: | |||
| schema: | |||
| openAPIV3Schema: | |||
| description: "ManagedCluster represents the desired state and current status | |||
There was a problem hiding this comment.
Suggestion: "ManagedCluster represents the desired state and current status
of a managed cluster. ManagedCluster is a cluster-scoped resource. The name
is the cluster UID. \n The cluster join process is a double opt-in
process. See the following join process steps: \n 1. The agent on the managed cluster creates a CSR on the hub
with the cluster UID and agent name. 2. The agent on the managed cluster
creates a ManagedCluster on the hub. 3. The cluster admin on the hub cluster approves
the CSR for the UID and agent name of the ManagedCluster. 4. The cluster
admin sets the spec.acceptClient of the ManagedCluster to true. 5. The cluster
admin on the managed cluster creates a credential of the kubeconfig for
the hub cluster. \n After the hub cluster creates the cluster namespace, the klusterlet agent
on the ManagedCluster pushes the credential to the hub cluster to use against the
kube-apiserver of the ManagedCluster."
|
@xuezhaojun Thanks for making these updates, I've gone through all the descriptions and added my suggestions. I mostly removed passive voice as per IBM style, otherwise they mostly looked good. |
Signed-off-by: GitHub <noreply@github.com>
xuezhaojun
force-pushed
the
improve-descriptions
branch
from
0b7cec2
to
cdb34dc
Compare
Thanks @oafischer, all suggestions are updated. |
|
/assign @qiujian16 Improved the descriptions of CRDs. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiujian16, xuezhaojun The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-merge-bot
bot
merged commit 480f8ab
into
open-cluster-management-io:main
Summary
The PR aims to enhance the overall quality of the API description section.