OperatorHub inconsistent to Documentation#28779
Conversation
|
The preview will be available shortly at: |
As long as this only appears in upstream docs, I am happy for it to be worked on (time permitting) and merged without QE ack. |
|
@vikram-redhat This PR is for OKD only |
| Elasticsearch is a memory-intensive application. By default, {product-title} installs three Elasticsearch nodes with memory requests and limits of 16 GB. This initial set of three {product-title} nodes might not have enough memory to run Elasticsearch within your cluster. If you experience memory issues that are related to Elasticsearch, add more Elasticsearch nodes to your cluster rather than increasing the memory on existing nodes. | ||
|
|
||
| ifdef::openshift-origin[] | ||
| * You muast have downloaded the link:https://cloud.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager site] as shown in the xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[installation procedure] to install this Operator. |
There was a problem hiding this comment.
| * You muast have downloaded the link:https://cloud.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager site] as shown in the xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[installation procedure] to install this Operator. | |
| * You must have downloaded the link: https://cloud.redhat.com/openshift/install/pull-secret[pull secret from the Red Hat OpenShift Cluster Manager site] as shown in the xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[installation procedure] to install this Operator. |
e287f4f to
09a8872
Compare
2f4f847 to
d6948e0
Compare
|
Deploy preview for osdocs ready! Built with commit 2f4f847802b710ebfcc8106bf0912a6e1e41309d |
|
Deploy preview for osdocs ready! Built with commit cc3475e |
bobfuru
left a comment
There was a problem hiding this comment.
A few thoughts about wrapping the CR in backticks and such.
There was a problem hiding this comment.
Do you want to mention what book/section this is in? I'm not looking at a preview build for this distro so I don't know whether it is clear here and elsewhere in the PR as to whether the user will understand where to find this procedure.
There was a problem hiding this comment.
@bobfuru How does this sound:
as shown in Obtaining the installation program in the installation documentation for your platform`
De we have a standard for such references?
There was a problem hiding this comment.
My brain is low on power, so I'm not sure but should this be "the OperatorHub custom resource (CR)"?
https://github.com/openshift/openshift-docs/blob/master/contributing_to_docs/doc_guidelines.adoc#object-references
There was a problem hiding this comment.
Same comment as above: "OperatorHub CR"?
There was a problem hiding this comment.
Yes to "OperatorHub CR" here, but no to "object" because I think it is somewhat redundant. My understanding is that this would only be either a CR or an object but not both. Also seems that "object" can be interchangeable with the generic term "resource". Not confusing at all. 😛
From docs_guidelines.adoc:
Use "object", "resource", "custom resource", "spec", etc. as appropriate after the object reference. This helps with clarity and readability.
There was a problem hiding this comment.
s/$ oc edit OperatorHub cluster/$ oc edit operatorhub cluster ? (Did you test to see if it works with caps? If so, ignore.)
There was a problem hiding this comment.
@bobfuru Both versions work. The object YAML uses OperatorHub, so I went with that.
apiVersion: config.openshift.io/v1
kind: OperatorHub
aa6a181 to
cc3475e
Compare
|
/cherrypick enterprise-4.5 |
|
@mburke5678: new pull request created: #29031 DetailsIn 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. |
|
/cherrypick enterprise-4.6 |
|
@mburke5678: new pull request created: #29033 DetailsIn 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. |
|
/cherrypick enterprise-4.7 |
|
@mburke5678: new pull request created: #29036 DetailsIn 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. |
okd-project/okd#432
Adding information on how to configure OKD to expose OpenShift operators if the user has the proper pull secret.