-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
[OSDOCS#9458]: 4.15 RN: Fix wrong acronyms #70813
[OSDOCS#9458]: 4.15 RN: Fix wrong acronyms #70813
Conversation
@obrown1205, please review. |
🤖 Tue Jan 30 09:07:40 - Prow CI generated the docs preview: https://70813--ocpdocs-pr.netlify.app |
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
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.
Actually the whole paragraph doesn't mean anything. The cluster CAPI operator allows provisionning Machines in the same fashion as what OpenShift's Machine API currently allows, but it does not provision a cluster as stated here. @mdbooth could you help produce a more accurate release note for CAPO in cluster CAPI operator?
For the record: release note text comes from here: https://issues.redhat.com/browse/OSASINFRA-3207. It was already tweaked by Matt and @stephenfin. |
Yeah, this text doesn't match what we said. I suspect there's more re-writing to be done here. |
Apologies! I received the "lgtm" so I assumed the definitions I had found on IBM's style guide were the correct ones. Thank you for correcting this! How can I help here? |
@@ -61,9 +61,9 @@ This release adds improvements related to the following components and concepts. | |||
[id="ocp-4-15-CAPO-tech-preview-no-upgrade"] | |||
==== CAPO integration into the cluster CAPI Operator (Tech Preview) | |||
|
|||
If you enable the `TechPreviewNoUpgrade` feature flag, the Coherent Accelerator Processor Interface (CAPI) Operator deploys the Cluster API Provider for OpenStack (CAPO) and manages its lifestyle. The CAPI Operator automatically creates an additional OpenStack cluster and an additional {product-title} cluster for the current {product-title} cluster. | |||
If you enable the `TechPreviewNoUpgrade` feature flag, the Cluster API (CAPI) Operator deploys the Cluster API Provider for OpenStack (CAPO) and manages its lifestyle. The CAPI Operator automatically creates an additional OpenStack cluster and an additional {product-title} cluster for the current {product-title} cluster. |
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.
If you enable the `TechPreviewNoUpgrade` feature flag, the Cluster API (CAPI) Operator deploys the Cluster API Provider for OpenStack (CAPO) and manages its lifestyle. The CAPI Operator automatically creates an additional OpenStack cluster and an additional {product-title} cluster for the current {product-title} cluster. | |
If you enable the `TechPreviewNoUpgrade` feature flag, the Cluster API (CAPI) Operator deploys the Cluster API Provider for OpenStack (CAPO) and manages its lifestyle. The CAPI Operator automatically creates `Cluster` and `OpenStackCluster` resources for the current {product-title} cluster. |
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.
Note that the Cluster
and OpenStackCluster
here are specific API resources provided by CAPI and CAPO respectively. We're not talking about "clusters" in the generic sense. As such, I think they need to be formatted as literals
.
|
||
It is now possible to configure the CAPI machine and OpenStack machine resources in a similar fashion to how the Mail Application Programming Interface (MAPI) resources are configured. It is important to note that the CAPI resources are equivalent to MAPI resources and not identical. | ||
It is now possible to configure the CAPI machine and OpenStack machine resources in a similar fashion to how the Machine API (MAPI) resources are configured. It is important to note that the CAPI resources are equivalent to MAPI resources and not identical. |
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.
It is now possible to configure the CAPI machine and OpenStack machine resources in a similar fashion to how the Machine API (MAPI) resources are configured. It is important to note that the CAPI resources are equivalent to MAPI resources and not identical. | |
It is now possible to configure CAPI `Machine` and CAPO `OpenStackMachine` resources in similar fashion to how Machine API (MAPI) resources are configured. It is important to note that the CAPI resources are equivalent to MAPI resources but not identical. |
All good 🙂 Please let me know what you think of my suggested replacement text. |
@stephenfin looks good to me! :) /lgtm |
44d8d75
to
7344135
Compare
7344135
to
0a8550f
Compare
I think I applied all of the @stephenfin suggestions here. |
CAPO stands for Cluster API and MAPO for Machine API. This commit fixes incorect explanations of these two acronyms.
0a8550f
to
81f24b7
Compare
@dulek: all tests passed! Full PR test history. Your PR dashboard. 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. I understand the commands that are listed here. |
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
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
CC @JoeAldinger |
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.
This lgtm but I think this PR needs to be against main
and not enterprise-4.15
.
Main does not have 4.15 release notes, release notes are only held in release branches: https://github.com/openshift/openshift-docs/blob/main/release_notes/ocp-4-15-release-notes.adoc?plain=1#L7-L8 |
Sorry, you're correct. Would you like this merged? |
CAPO stands for Cluster API and MAPO for Machine API. This commit fixes incorect explanations of these two acronyms.
This fixes mistakes introduced in #70637.
Version(s):
4.15
Issue:
https://issues.redhat.com/browse/OSDOCS-9302
Link to docs preview:
https://70813--ocpdocs-pr.netlify.app/openshift-enterprise/latest/release_notes/ocp-4-15-release-notes
QE review:
Additional information: