[OSDOCS#9458]: 4.15 RN: Fix wrong acronyms by dulek · Pull Request #70813 · openshift/openshift-docs

dulek · 2024-01-25T08:58:37Z

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:

QE has approved this change.

Additional information:

dulek · 2024-01-25T08:59:32Z

@obrown1205, please review.

ocpdocs-previewbot · 2024-01-25T09:05:33Z

🤖 Tue Jan 30 09:07:40 - Prow CI generated the docs preview: https://70813--ocpdocs-pr.netlify.app

mandre

/lgtm

mandre

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?

dulek · 2024-01-25T16:12:40Z

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.

stephenfin · 2024-01-25T16:25:05Z

Yeah, this text doesn't match what we said. I suspect there's more re-writing to be done here.

obrown1205 · 2024-01-25T18:00:27Z

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?

stephenfin · 2024-01-26T12:13:10Z

release_notes/ocp-4-15-release-notes.adoc

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


Suggested change

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.

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.

stephenfin · 2024-01-26T12:13:17Z

release_notes/ocp-4-15-release-notes.adoc

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

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


Suggested change

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.

stephenfin · 2024-01-26T12:16:16Z

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?

All good 🙂 Please let me know what you think of my suggested replacement text.

obrown1205 · 2024-01-26T14:33:18Z

@stephenfin looks good to me! :) /lgtm

dulek · 2024-01-29T16:25:43Z

I think I applied all of the @stephenfin suggestions here.

release_notes/ocp-4-15-release-notes.adoc

CAPO stands for Cluster API and MAPO for Machine API. This commit fixes incorect explanations of these two acronyms.

openshift-ci · 2024-01-30T09:09:58Z

@dulek: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

mdbooth

/lgtm

mandre

/lgtm

obrown1205 · 2024-01-30T13:13:02Z

CC @JoeAldinger

JoeAldinger

This lgtm but I think this PR needs to be against main and not enterprise-4.15.

dulek · 2024-01-31T10:27:52Z

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

JoeAldinger · 2024-01-31T12:30:19Z

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?

openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jan 25, 2024

dulek changed the title ~~[OSDOCS#9302]: 4.15 RN: Fix wrong acronyms~~ [OSDOCS#9458]: 4.15 RN: Fix wrong acronyms Jan 25, 2024

mandre reviewed Jan 25, 2024

View reviewed changes

openshift-ci bot assigned mandre Jan 25, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 25, 2024

openshift-ci bot assigned EmilienM Jan 25, 2024

mandre reviewed Jan 25, 2024

View reviewed changes

stephenfin suggested changes Jan 26, 2024

View reviewed changes

dulek force-pushed the fix-capo-acronyms branch from 44d8d75 to 7344135 Compare January 29, 2024 16:24

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jan 29, 2024

dulek force-pushed the fix-capo-acronyms branch from 7344135 to 0a8550f Compare January 29, 2024 16:25

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 29, 2024

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 29, 2024

mandre reviewed Jan 30, 2024

View reviewed changes

release_notes/ocp-4-15-release-notes.adoc Outdated Show resolved Hide resolved

4.15 RN: Fix wrong acronyms

81f24b7

CAPO stands for Cluster API and MAPO for Machine API. This commit fixes incorect explanations of these two acronyms.

dulek force-pushed the fix-capo-acronyms branch from 0a8550f to 81f24b7 Compare January 30, 2024 08:58

mdbooth approved these changes Jan 30, 2024

View reviewed changes

openshift-ci bot assigned mdbooth Jan 30, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 30, 2024

mandre reviewed Jan 30, 2024

View reviewed changes

JoeAldinger added branch/enterprise-4.15 peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jan 30, 2024

JoeAldinger added this to the Planned for 4.15 GA milestone Jan 30, 2024

JoeAldinger added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Jan 30, 2024

JoeAldinger reviewed Jan 30, 2024

View reviewed changes

JoeAldinger merged commit 99f6929 into openshift:enterprise-4.15 Jan 31, 2024

jeana-redhat mentioned this pull request Apr 23, 2024

fix terms in CAPI for OpenStack RNs #75024

Merged

	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.

	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.

Conversation

dulek commented Jan 25, 2024 • edited by JoeAldinger Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dulek commented Jan 25, 2024

Uh oh!

ocpdocs-previewbot commented Jan 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mandre left a comment

Choose a reason for hiding this comment

Uh oh!

mandre left a comment

Choose a reason for hiding this comment

Uh oh!

dulek commented Jan 25, 2024

Uh oh!

stephenfin commented Jan 25, 2024

Uh oh!

obrown1205 commented Jan 25, 2024

Uh oh!

stephenfin Jan 26, 2024

Choose a reason for hiding this comment

Uh oh!

stephenfin Jan 26, 2024

Choose a reason for hiding this comment

Uh oh!

stephenfin Jan 26, 2024

Choose a reason for hiding this comment

Uh oh!

stephenfin commented Jan 26, 2024

Uh oh!

obrown1205 commented Jan 26, 2024

Uh oh!

dulek commented Jan 29, 2024

Uh oh!

Uh oh!

openshift-ci bot commented Jan 30, 2024

Uh oh!

mdbooth left a comment

Choose a reason for hiding this comment

Uh oh!

mandre left a comment

Choose a reason for hiding this comment

Uh oh!

obrown1205 commented Jan 30, 2024

Uh oh!

JoeAldinger left a comment

Choose a reason for hiding this comment

Uh oh!

dulek commented Jan 31, 2024

Uh oh!

JoeAldinger commented Jan 31, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

dulek commented Jan 25, 2024 •

edited by JoeAldinger

Loading

ocpdocs-previewbot commented Jan 25, 2024 •

edited

Loading