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
add base documentation for all operator+config resources #15905
Conversation
/cherry-pick enterprise-4.1 |
@bparees: once the present PR merges, I will cherry-pick it on top of enterprise-4.1 in a new PR and assign it to you. 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. |
/cherry-pick enterprise-4.2 |
@bparees: once the present PR merges, I will cherry-pick it on top of enterprise-4.2 in a new PR and assign it to you. 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. |
/assign @kalexand-rh bump |
@xltian - could you please get someone to give QE approval for this? |
@jianzhangbjz can you please review? thanks |
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
@xltian @jianzhangbjz bump |
@xltian @bparees Sorry for the late to reply. LGTM based on my understanding. |
From the PR, most of description is related to all kinds of operators, nothing with installer, I can not provide much information here. After a glance, LGTM. |
@vikram-redhat @kalexand-rh sounds like this is good to go. |
[id="operator-configuration-resources_{context}"] | ||
== Operator configuration resources | ||
|
||
These configuration resources are cluster scoped singletons which control behavior of a specific component as |
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.
s/cluster scoped/cluster-scoped
Is there a better word for singletons? It is not a term we use, likely to techie or jargony
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.
The concept here is that there is a single instance of this resource type for the entire cluster. Open to suggestions.
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.
I think cluster-scoped instance
is OK.
@bparees looks like one change requested for cluster scoped to cluster-scoped. When you will update that, I will merge and CP. Thanks for submitting this. |
@vikram-redhat change requests applied. |
@openshift/team-documentation I think you guys are the perfect candidate for github's suggested changes feature: saves the PR author time since they don't have to go make the edits you are proposing, repush the PR, etc. |
@bparees nice suggestion and I will bring it up with the team. Thanks for making the fix. I will merge and CP. |
@bparees: new pull request created: #16132 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. |
@bparees: new pull request created: #16133 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. |
@bparees The Custom Resources section that you edited is currently commented-out and doesn't appear. Should these resources be exposed in the docs? |
no, that content should just be deleted at this point. i'm not sure why it was put in as commented out in the first place. |
or you can leave them commented out and as teams decide to go document their operator-specific resources they can uncomment them. |
Editorial follow up: #16143 |
@mburke5678, I made the table earlier in the 4.1 release and removed it after some feedback from Derek. It wasn't clear if it would be required later. |
/retitle Bug 1729308: add base documentation for all operator+config resources |
No description provided.