[OSDOCS-16999] IBM Cloud VPC CQA: structural changes by SNiemann15 · Pull Request #117834 · openshift/openshift-docs

SNiemann15 · 2026-08-12T14:10:26Z

Version(s): 4.20+

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

QE review:

QE has approved this change.

Additional information:

ocpdocs-previewbot · 2026-08-12T14:19:21Z

🤖 Thu Aug 13 15:52:38 - Prow CI generated the docs preview:
https://117834--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

openshift-ci · 2026-08-13T15:54:49Z

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

SNiemann15 · 2026-08-13T16:51:22Z

/label merge-review-needed

lahinson

@SNiemann15 Looks good overall. I commented on a couple of small things to fix. I also can't tell from this PR where the new assembly came from. Would you let me know? I'd feel more comfortable merging when I know the origin of that content. Thanks!

lahinson · 2026-08-14T13:52:59Z

Is this content not needed anymore? If I'm missing something, let me know. I can't tell from this PR why this file is being deleted.

lahinson · 2026-08-14T13:53:57Z

I assume this is already existing content that you are moving to its own assembly -- is that correct? If so, can you let me know where the content is coming from? If it's new content, it needs QE approval.

lahinson · 2026-08-14T13:55:50Z

 include::modules/installation-cis-ibm-cloud.adoc[leveloffset=+2]

+[role="_additional-resources"]
+[id="additional-resources_installing-ibm-cloud-account-cis"]


Suggested change

[id="additional-resources_installing-ibm-cloud-account-cis"]

This type of "Additional resources" section does not use an anchor.

lahinson · 2026-08-14T13:56:01Z

 include::modules/installation-dns-ibm-cloud.adoc[leveloffset=+2]

+[role="_additional-resources"]
+[id="additional-resources_installing-ibm-cloud-account-dns"]


Suggested change

[id="additional-resources_installing-ibm-cloud-account-dns"]

lahinson · 2026-08-14T14:02:00Z

-* `--included`: Includes only the manifests that your specific cluster configuration requires.
-* `<path_to_directory_with_installation_configuration>`: Specify the location of the `install-config.yaml` file.
-* `<path_to_directory_for_credentials_requests>`: Specify the path to the directory where you want to store the `CredentialsRequest` objects. If the specified directory does not exist, this command creates it.
+


For this type of structure, where you're using "where:" and a definition list, the items in the list must be of the same type.

Reference: https://docs.google.com/document/d/1j78SA8Y-ZRlVATbVe6D8bdYj7mQzzhOJtGt1xH_3qa0/edit?usp=sharing

I'm not sure if that link is Red Hat only, so in case it is, I've copied the guidance here:

"Do not mix and match multiple callout alternative methods for a single code block explanation; ensure that a list presents the same kind of information throughout. For example, you could define user-replaceable values or use dot notation paths in a definition list, but do not mix both in one list."

My next two suggested edits show are related to this guidance.

lahinson · 2026-08-14T14:02:46Z

+where:
+
+`--included`:: Specifies that only the manifests that your specific cluster configuration requires are included.
+`<path_to_directory_with_installation_configuration>`:: Specifies the location of the `install-config.yaml` file.


Suggested change

`<path_to_directory_with_installation_configuration>`:: Specifies the location of the `install-config.yaml` file.

`--install-config`:: Specifies the location of the `install-config.yaml` file.

lahinson · 2026-08-14T14:03:09Z

+
+`--included`:: Specifies that only the manifests that your specific cluster configuration requires are included.
+`<path_to_directory_with_installation_configuration>`:: Specifies the location of the `install-config.yaml` file.
+`<path_to_directory_for_credentials_requests>`:: Specifies the path to the directory where you want to store the `CredentialsRequest` objects. If the specified directory does not exist, this command creates it.


Suggested change

`<path_to_directory_for_credentials_requests>`:: Specifies the path to the directory where you want to store the `CredentialsRequest` objects. If the specified directory does not exist, this command creates it.

`--to`:: Specifies the path to the directory where you want to store the `CredentialsRequest` objects. If the specified directory does not exist, this command creates it.

lahinson · 2026-08-14T14:19:21Z


-[id="next-steps_preparing-to-install-on-ibm-cloud"]
-== Next steps
+[role="_additional-resources"]


I noticed that several of the documentation titles that these links point to have changed, likely because of other CQA work. In a separate PR, it might be good to do a sweep on the link text and make sure that it matches the current titles.

openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 12, 2026