Skip to content

OSDOCS-17040: platform agnostic CQA#115208

Merged
skopacz1 merged 1 commit into
openshift:mainfrom
skopacz1:OSDOCS-17040_3
Jul 16, 2026
Merged

OSDOCS-17040: platform agnostic CQA#115208
skopacz1 merged 1 commit into
openshift:mainfrom
skopacz1:OSDOCS-17040_3

Conversation

@skopacz1

@skopacz1 skopacz1 commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

OSDOCS-17040

Version(s): 4.20+

CQA for platform agnostic install docs

QE review: QE review not required IMO, let me know if you see anything that makes you disagree.

Previews:

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

openshift-ci-robot commented Jul 13, 2026

Copy link
Copy Markdown

@skopacz1: This pull request references OSDOCS-17040 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.0.0" version, but no target version was set.

Details

In response to this:

Version(s):

Issue:

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 openshift-ci Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 13, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 13, 2026

Copy link
Copy Markdown

🤖 Thu Jul 16 18:07:22 - Prow CI generated the docs preview:
https://115208--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

Comment thread installing/installing_platform_agnostic/installing-platform-agnostic.adoc Outdated
@skopacz1 skopacz1 added the merge-review-needed Signifies that the merge review team needs to review this PR label Jul 13, 2026
@ShaunaDiaz ShaunaDiaz added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Jul 16, 2026

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

few thoughts, otherwise lgtm

For a cluster that contains user-provisioned infrastructure, you must deploy all
of the required machines.

This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. No newline at end of file

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.

Suggested change
This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.

no self-referential text

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is intentionally kept as its own paragraph so it's not part of the short description

= Requirements for a cluster with user-provisioned infrastructure

[role="_abstract"]
For a cluster that contains user-provisioned infrastructure, you must deploy all

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.

Suggested change
For a cluster that contains user-provisioned infrastructure, you must deploy all
For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines.

no line breaks

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good point, no need to keep existing hard wrapping if I am making a new module anyways


[role="_abstract"]
For a cluster that contains user-provisioned infrastructure, you must deploy all
of the required 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.

Suggested change
of the required machines.

[id="installation-requirements-user-infra_{context}"]
= Requirements for a cluster with user-provisioned infrastructure

[role="_abstract"]

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.

I don't think a module that is just an abstract is valid; can this content go somewhere else?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

If anything the only alternative would be to delete this instead of moving it anywhere, imo. But we have also been modularizing these little stubs in a lot of cases for install CQAs (not sure about how consistently across the entire docs), so I am in favor of keeping it and worrying about it later during the quality pass of CQAs post-migration.

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.

I was checking around, and it is NOT valid, so this will break migration. Let me find the resource and Slack it over to you.

Comment thread installing/installing_platform_agnostic/installing-platform-agnostic.adoc Outdated
@ShaunaDiaz ShaunaDiaz removed the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Jul 16, 2026
@openshift-ci

openshift-ci Bot commented Jul 16, 2026

Copy link
Copy Markdown

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

@skopacz1
skopacz1 merged commit 0632515 into openshift:main Jul 16, 2026
2 checks passed
@skopacz1

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.20

@skopacz1

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.21

@skopacz1

Copy link
Copy Markdown
Contributor Author

/cherrypick enterprise-4.22
/cherrypick enterprise-5.0

@openshift-cherrypick-robot

Copy link
Copy Markdown

@skopacz1: new pull request created: #115605

Details

In response to this:

/cherrypick enterprise-4.20

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.

@openshift-cherrypick-robot

Copy link
Copy Markdown

@skopacz1: new pull request created: #115606

Details

In response to this:

/cherrypick enterprise-4.21

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.

@openshift-cherrypick-robot

Copy link
Copy Markdown

@skopacz1: new pull request created: #115607

Details

In response to this:

/cherrypick enterprise-4.22
/cherrypick enterprise-5.0

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.

@openshift-cherrypick-robot

Copy link
Copy Markdown

@skopacz1: new pull request created: #115608

Details

In response to this:

/cherrypick enterprise-4.22
/cherrypick enterprise-5.0

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.20 branch/enterprise-4.21 branch/enterprise-4.22 branch/enterprise-5.0 jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. 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.

6 participants