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.

Sign up for GitHub

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

Jump to bottom

[OSDOCS#9458]: 4.15 RN: Fix wrong acronyms #70813

Merged
merged 1 commit into from
Jan 31, 2024
Merged

[OSDOCS#9458]: 4.15 RN: Fix wrong acronyms #70813

merged 1 commit into from
Jan 31, 2024

Conversation

dulek
Copy link
Contributor

@dulek dulek commented Jan 25, 2024 •
edited by JoeAldinger

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:

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

dulek commented Jan 25, 2024

@obrown1205, please review.

@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jan 25, 2024 •
edited

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

@dulek dulek changed the title [OSDOCS#9302]: 4.15 RN: Fix wrong acronyms [OSDOCS#9458]: 4.15 RN: Fix wrong acronyms Jan 25, 2024
mandre
mandre reviewed Jan 25, 2024
View reviewed changes
Copy link
Member

@mandre mandre left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 25, 2024
mandre
mandre reviewed Jan 25, 2024
View reviewed changes
Copy link
Member

@mandre mandre left a 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?

@dulek
Copy link
Contributor Author

dulek commented Jan 25, 2024

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

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

@obrown1205
Copy link
Contributor

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
stephenfin suggested changes Jan 26, 2024
View reviewed changes
release_notes/ocp-4-15-release-notes.adoc Outdated
@@ -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.
Copy link

Choose a reason for hiding this comment

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

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.

Copy link

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.

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

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

Choose a reason for hiding this comment

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

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

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

@stephenfin looks good to me! :) /lgtm

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jan 29, 2024
@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 29, 2024
@dulek
Copy link
Contributor Author

dulek commented Jan 29, 2024

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

@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 29, 2024
@dulek
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.
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Jan 30, 2024

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

mdbooth
mdbooth approved these changes Jan 30, 2024
View reviewed changes
Copy link

@mdbooth mdbooth left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 30, 2024
mandre
mandre reviewed Jan 30, 2024
View reviewed changes
Copy link
Member

@mandre mandre left a comment

Choose a reason for hiding this comment

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

/lgtm

@obrown1205
Copy link
Contributor

CC @JoeAldinger

@JoeAldinger 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 JoeAldinger added this to the Planned for 4.15 GA milestone Jan 30, 2024
@JoeAldinger 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
JoeAldinger reviewed Jan 30, 2024
View reviewed changes
Copy link
Contributor

@JoeAldinger JoeAldinger left a 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.

@dulek
Copy link
Contributor Author

dulek commented Jan 31, 2024

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

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?

@JoeAldinger JoeAldinger merged commit 99f6929 into openshift:enterprise-4.15 Jan 31, 2024
2 checks passed
@jeana-redhat jeana-redhat mentioned this pull request Apr 23, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mandre mandre mandre left review comments

@JoeAldinger JoeAldinger JoeAldinger left review comments

@stephenfin stephenfin stephenfin requested changes

@mdbooth mdbooth mdbooth approved these changes

Assignees

@mandre mandre

@mdbooth mdbooth

@EmilienM EmilienM

Labels
branch/enterprise-4.15 lgtm Indicates that a PR is ready to be merged. peer-review-done Signifies that the peer review team has reviewed this PR size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
OCP 4.15 GA
Development

Successfully merging this pull request may close these issues.

None yet
9 participants
@dulek @ocpdocs-previewbot @stephenfin @obrown1205 @JoeAldinger @mandre @mdbooth @EmilienM @openshift-merge-robot