Skip to content

OSDOCS-16991_j_2#Reconciling main and changes introduced in PR #11348 - #118841

Merged
brendan-daly-red-hat merged 1 commit into
openshift:mainfrom
brendan-daly-red-hat:OSDOCS-16991_j_fixes
Aug 26, 2026
Merged

OSDOCS-16991_j_2#Reconciling main and changes introduced in PR #11348#118841
brendan-daly-red-hat merged 1 commit into
openshift:mainfrom
brendan-daly-red-hat:OSDOCS-16991_j_fixes

Conversation

@brendan-daly-red-hat

@brendan-daly-red-hat brendan-daly-red-hat commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 25, 2026
@openshift-ci-robot

openshift-ci-robot commented Aug 25, 2026

Copy link
Copy Markdown

@brendan-daly-red-hat: This pull request references OSDOCS-16991 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "5.1.0" version, but no target version was set.

Details

In response to this:

Version:
main

Issue:
https://redhat.atlassian.net/browse/OSDOCS-16991

This PR cherry-picks CQA fixes from PR #118348 (enterprise-4.20) to main.

Changes

  • Adds short descriptions to AWS UPI modules
  • Replaces callouts with "where:" description lists per DITA migration requirements
  • Improves procedural language (user-focused, active voice)
  • Fixes capitalization (kubelet, not Kubelet)

Files changed

  • modules/installation-approve-csrs.adoc
  • modules/installation-aws-creating-cloudformation-stack-compute.adoc
  • modules/installation-aws-regions-with-no-ami.adoc
  • modules/installation-aws-upload-custom-rhcos-ami.adoc
  • modules/installation-aws-user-infra-installation.adoc

QE review:
QE approval not required for CQA changes.

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 25, 2026
@brendan-daly-red-hat brendan-daly-red-hat changed the title OSDOCS-16991: CQA fixes for AWS UPI modules OSDOCS-16991_j_2: Fixes for 4.20 cherrypick Aug 25, 2026
@openshift-ci-robot

Copy link
Copy Markdown

@brendan-daly-red-hat: No Jira issue is referenced in the title of this pull request.
To reference a jira issue, add 'XYZ-NNN:' to the title of this pull request and request another refresh with /jira refresh.

Details

In response to this:

Version:
5.0+

Issue:
https://redhat.atlassian.net/browse/OSDOCS-16991

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot openshift-ci-robot removed the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Aug 25, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Aug 25, 2026

Copy link
Copy Markdown

🤖 Wed Aug 26 08:50:07 - Prow CI generated the docs preview:
https://118841--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

@skopacz1

Copy link
Copy Markdown
Contributor

Just an FYI to others that this PR is a reconciliation between main and the changes that were introduced as part of #118348, which was a 4.20-based PR that was cherry picked to 4.21+ but the changes were not made in the main branch.

This PR cherry picks the commit from the previous PR, so that main and all the 4.20+ enterprise branches are all as close as possible to each other.

@skopacz1 skopacz1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Left a few comments, the first one is for something you should not change in this PR but rather fix in a follow up after merging. The second one is something you must do in this PR (revert all the changes in modules/installation-aws-upload-custom-rhcos-ami.adoc)

:_mod-docs-content-type: PROCEDURE
[id="installation-aws-creating-cloudformation-stack_{context}"]
= Creating the CloudFormation stack for compute machines
= Creating the `CloudFormation` stack for compute machines

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is technically correct to change because now this will align with the same change made in the enterprise branches.

However, more generally we shouldn't have monospace formatting in headings at all. So this should be kept in this PR for the sake of reconciliation, but then undone in a new 4.20+ PR that is based off of the main branch

(sorry if that sounds confusing, but I think in this PR we should just reconcile differences first, and make any 4.20+ revisions in a separate PR that can be cleanly cherry picked)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

TLDR revert every single change made in this file in this PR.

I actually merged a lot of changes to this file in main and 4.20+ as part of Silke's #118245. Merging this file as-is would create a discrepancy between main and enterprise branches rather than resolving them.

So for this fille:

  1. Revert all changes in this PR so this file doesn't show up in the diff at all
  2. If you still want to implement any of these changes, such as removing hard wrapping or adding attributes, please then make those changes in a clean 4.20+ PR based off of main, after merging this

Cherry-picked from enterprise-4.20 PR openshift#118348 to main.

Changes:
- Replace callouts with 'where:' description lists per DITA migration
- Improve procedural language (user-focused active voice)
- Fix capitalization (kubelet not Kubelet)
- Simplify wording ('Use' instead of 'It is recommended')

Files:
- modules/installation-approve-csrs.adoc
- modules/installation-aws-creating-cloudformation-stack-compute.adoc
- modules/installation-aws-regions-with-no-ami.adoc
- modules/installation-aws-user-infra-installation.adoc
@openshift-ci openshift-ci Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 26, 2026
@openshift-ci

openshift-ci Bot commented Aug 26, 2026

Copy link
Copy Markdown

@brendan-daly-red-hat: 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-sigs/prow repository. I understand the commands that are listed here.

@brendan-daly-red-hat brendan-daly-red-hat changed the title OSDOCS-16991_j_2: Fixes for 4.20 cherrypick OSDOCS-16991_j_2#Reconciling main and changes introduced in PR #11348 Aug 26, 2026
@brendan-daly-red-hat
brendan-daly-red-hat merged commit 65a82eb into openshift:main Aug 26, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants