-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[ISSUE-5] fix docs; add missing descriptions #6
[ISSUE-5] fix docs; add missing descriptions #6
Conversation
@jameskim0987 please add documentation to "api/v1alpha1/argocdrole_types.go" and RoleBinding. You can look at status.go for valid structure of documentation. |
76eee20
to
88a8864
Compare
@ggkhrmv This PR is ready for review. Let me know if I missed any or need to modify the comments! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jameskim0987 I left a few comments and suggestions, please incorporate them, after that I can approve the PR :)
items: | ||
type: string | ||
type: array | ||
resource: | ||
description: Target resource type. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jameskim0987 could you please add those comments (objects, resource, verbs, ...) to the api/v1alpha1/argocdrole_types.go? otherwise the changes will be overriden, if we change something in the types file and generate the yaml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure thing! Done.
config/crd/bases/rbac-operator.argoproj-labs.io_argocdrolebindings.yaml
Outdated
Show resolved
Hide resolved
config/crd/bases/rbac-operator.argoproj-labs.io_argocdrolebindings.yaml
Outdated
Show resolved
Hide resolved
config/crd/bases/rbac-operator.argoproj-labs.io_argocdroles.yaml
Outdated
Show resolved
Hide resolved
config/crd/bases/rbac-operator.argoproj-labs.io_argocdroles.yaml
Outdated
Show resolved
Hide resolved
config/crd/bases/rbac-operator.argoproj-labs.io_argocdroles.yaml
Outdated
Show resolved
Hide resolved
0535c99
to
e1ec49c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jameskim0987 please make the changes and run make manifests
and make install
. If there are any file changes, please also commit them :)
config/crd/bases/rbac-operator.argoproj-labs.io_argocdrolebindings.yaml
Outdated
Show resolved
Hide resolved
config/crd/bases/rbac-operator.argoproj-labs.io_argocdroles.yaml
Outdated
Show resolved
Hide resolved
Signed-off-by: James Kim <[email protected]>
Signed-off-by: James Kim <[email protected]>
Signed-off-by: James Kim <[email protected]>
Signed-off-by: James Kim <[email protected]>
Signed-off-by: James Kim <[email protected]>
Signed-off-by: James Kim <[email protected]>
Signed-off-by: James Kim <[email protected]>
Signed-off-by: James Kim <[email protected]>
Signed-off-by: James Kim <[email protected]>
Signed-off-by: James Kim <[email protected]>
Signed-off-by: James Kim <[email protected]>
f3c9511
to
5c117a2
Compare
Thank you for the pointers! While running I completed making the changes and the changes can be viewed at https://doc.crds.dev/github.com/jameskim0987/[email protected] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@jameskim0987 LGTM, thanks for your help :) |
What type of PR is this?
/kind documentation
What does this PR do / why we need it:
Have you updated the necessary documentation?
Which issue(s) this PR fixes:
Fixes #5
How to test changes / Special notes to the reviewer: