Skip to content
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

Merged
merged 2 commits into from Aug 6, 2019

Conversation

bparees
Copy link
Contributor

@bparees bparees commented Jul 16, 2019

No description provided.

@openshift-ci-robot openshift-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 16, 2019
@bparees
Copy link
Contributor Author

bparees commented Jul 16, 2019

/cherry-pick enterprise-4.1

@openshift-cherrypick-robot

@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:

/cherry-pick enterprise-4.1
/cherry-pick enterprise-4.2

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
Copy link
Contributor Author

bparees commented Jul 16, 2019

/cherry-pick enterprise-4.2

@openshift-cherrypick-robot

@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:

/cherry-pick enterprise-4.2

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
Copy link
Contributor Author

bparees commented Jul 23, 2019

/assign @kalexand-rh

bump

@vikram-redhat
Copy link
Contributor

@xltian - could you please get someone to give QE approval for this?

@xltian
Copy link

xltian commented Jul 26, 2019

@jianzhangbjz can you please review? thanks

Copy link
Member

@sdodson sdodson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bparees
Copy link
Contributor Author

bparees commented Jul 30, 2019

@xltian @jianzhangbjz bump

@jianzhangbjz
Copy link

@xltian @bparees Sorry for the late to reply. LGTM based on my understanding.
@jianlinliu Since it's related to the installation mainly, could you help double-review this document prevent me missing something else? Thanks!

@jianlinliu
Copy link

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.

@bparees
Copy link
Contributor Author

bparees commented Aug 5, 2019

@vikram-redhat @kalexand-rh sounds like this is good to go.

@vikram-redhat vikram-redhat added the peer-review-needed Signifies that the peer review team needs to review this PR label Aug 5, 2019
[id="operator-configuration-resources_{context}"]
== Operator configuration resources

These configuration resources are cluster scoped singletons which control behavior of a specific component as
Copy link
Contributor

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

Copy link
Contributor Author

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.

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.

@vikram-redhat vikram-redhat added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Aug 6, 2019
@vikram-redhat
Copy link
Contributor

@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.

@bparees
Copy link
Contributor Author

bparees commented Aug 6, 2019

@vikram-redhat change requests applied.

@bparees
Copy link
Contributor Author

bparees commented Aug 6, 2019

@openshift/team-documentation I think you guys are the perfect candidate for github's suggested changes feature:
https://twitter.com/github/status/1053360435074949120?lang=en

saves the PR author time since they don't have to go make the edits you are proposing, repush the PR, etc.

@vikram-redhat
Copy link
Contributor

@bparees nice suggestion and I will bring it up with the team. Thanks for making the fix. I will merge and CP.

@openshift-cherrypick-robot

@bparees: new pull request created: #16132

In response to this:

/cherry-pick enterprise-4.1

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.

@openshift-cherrypick-robot

@bparees: new pull request created: #16133

In response to this:

/cherry-pick enterprise-4.2

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.

@mburke5678
Copy link
Contributor

@bparees The Custom Resources section that you edited is currently commented-out and doesn't appear. Should these resources be exposed in the docs?
https://github.com/openshift/openshift-docs/pull/15905/files#diff-162300a9be635b34c5f6aeef7585d971R160

@bparees
Copy link
Contributor Author

bparees commented Aug 6, 2019

@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.

@bparees
Copy link
Contributor Author

bparees commented Aug 6, 2019

or you can leave them commented out and as teams decide to go document their operator-specific resources they can uncomment them.

@mburke5678
Copy link
Contributor

Editorial follow up: #16143

@kalexand-rh
Copy link
Contributor

@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.

@abhinavdahiya
Copy link

/retitle Bug 1729308: add base documentation for all operator+config resources

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.1 branch/enterprise-4.2 peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet