Doc Update #114
Doc Update #114
Conversation
This will help unify the style across the repositories. In particular, the language around the DCO requirement and who can submit PRs. The community template is at: https://github.com/open-cluster-management/community/blob/main/common_repo_templates/CONTRIBUTING_template.md Signed-off-by: Justin Kulikauskas <justin.kulikauskas@gmail.com>
|
Hi @JustinKuli. Thanks for your PR. I'm waiting for a open-cluster-management member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
|
/cc @ycao56 |
The content and format here is based off of the great example of the cert-policy-controller. The example is from the `policy-pod` in the policy-collection. The fields are from configurationpolicy_types.go, and I marked them as required or optional depending on if they seemed necessary for the policy to work as expected; most of them had `omitempty` in their go struct tags, so they aren't *technically* required. Signed-off-by: Justin Kulikauskas <justin.kulikauskas@gmail.com>
|
can you reorg the README according to latest template in https://github.com/open-cluster-management/community/blob/main/common_repo_templates/README_template.md? |
The community template can be found here: https://github.com/open-cluster-management/community/blob/main/common_repo_templates/README_template.md Signed-off-by: Justin Kulikauskas <justin.kulikauskas@gmail.com>
|
/ok-to-test |
|
Kudos, SonarCloud Quality Gate passed!
|
|
/approve |
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: JustinKuli, ycao56 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 |
|
Kudos, SonarCloud Quality Gate passed!
|
To help new users/contributors get up to speed on this component, I think an example YAML and some description of what each field does would be very helpful. Additionally, the requirements around contributing are more clear in the community's template, so I've pulled that information into this repo.
@ycao56, I hadn't noticed your PR #111 when I made this, there is definitely overlap in our changes, sorry.
Regarding some of the fields in the table, I noticed (and tested) that the specific options for
remediationActionandcomplianceTypeare not enforced by the controller. Arbitrary values can be input into those fields and the spec is not rejected: it just leads to (possibly) unexpected behavior. Similarly, most of the fields are not strictly "required", but without filling them in the behavior of the controller is not obvious without looking at the code and trying it out.