[OSDOCS#17012]: Bare metal ipi CQA workflow 1 by rh-sgehlot · Pull Request #117340 · openshift/openshift-docs

rh-sgehlot · 2026-08-05T15:16:04Z

Version(s):
4.20 +

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

Link to docs preview:
https://117340--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_bare_metal/ipi/ipi-install-installation-workflow

QE review:

QE has approved this change.
QE approval not required as no change to the content.

Additional information:
Assemby and modules till "Configuring host network interfaces" are covered here. Second PR - #117420

ocpdocs-previewbot · 2026-08-05T15:31:31Z

🤖 Wed Aug 05 15:49:02 - Prow CI generated the docs preview:
https://117340--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

openshift-ci · 2026-08-05T15:50:24Z

@rh-sgehlot: 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

Left some comments, but I think you did a nice job with the work here. Will take another look once feedback is addressed

skopacz1 · 2026-08-06T16:34:01Z


 toc::[]
+[role="_abstract"]
+Review the different methods for installing {product-title} on bare metal and setup your environment for installation.


I don't see anything on this assembly that talks about different install methods (which makes sense - by the time you're on a page in the bare metal IPI install section, you've already decided on this method). I would suggest focusing on the environment setup only:

Suggested change

Review the different methods for installing {product-title} on bare metal and setup your environment for installation.

Before you can install an {product-title} cluster on bare metal, you must set up your environment for installation.

(also a nit here that "set up" is two words as a verb, and "setup" is only used as a noun, per the ISG)

skopacz1 · 2026-08-06T17:06:55Z

@@ -68,9 +69,9 @@ interfaces:
 # ...
 ----
 +
-.. For a network using static IP addressing and no DHCP network, create an NMState YAML file and specify the bare-metal bridge interface details in the file:
+.. For a network using static IP addressing and no DHCP network, create an NMState YAML file and specify the bare metal bridge interface details in the file:
 +
-.Example bare-metal bridge interface configuration that uses static IP addressing and no DHCP network
+.Example bare metal bridge interface configuration that uses static IP addressing and no DHCP network


Just an FYI that if you changed all these "bare-metal" instances to "bare metal" because a bot on this PR commented to do so, I think that bot is incorrect. This is "bare-metal" used as a (compound) adjective, which, when preceding the noun it modifies, should be hyphenated. See the SSG entries on bare metal for more info

So I would revert these changes to say "bare-metal", and if you made similar changes anywhere else I would revert those too (do note - using it as a noun like "install on bare metal" is valid to have as two unhyphenated words)

skopacz1 · 2026-08-06T17:10:51Z

          # Serve time even if not synchronized to a time source.
          local stratum 3 orphan
 ----
-+


Lol I am confused by how these description lists still indent correctly and don't restart the number order without the first +, but I guess if it works it works

skopacz1 · 2026-08-06T17:17:31Z

 [id="ipi-install-creating-a-disconnected-registry_{context}"]
 = Creating a disconnected registry

+[]


Gotta fill this one out 😅

skopacz1 · 2026-08-06T17:18:54Z

 ====
-Creating a disconnected registry on a registry node is optional. If you need to create a disconnected registry on a registry node, you must complete all of the following sub-sections.
+* Creating a disconnected registry on a registry node is optional. If you need to create a disconnected registry on a registry node, you must complete all of the following sub-sections.
+* If you have already prepared a mirror registry for a disconnected installation by mirroring images, you can skip directly to "Modify the install-config.yaml file to use the disconnected registry" section. For more information about preparing a mirror registry for a disconnected installation by mirroring images see, "Mirroring images for a disconnected installation".


Yeah this is a smart way to deal with that "prereqs" section that didn't really seem to be written like a prereqs section

skopacz1 · 2026-08-06T17:27:53Z

-:_mod-docs-content-type: PROCEDURE
+:_mod-docs-content-type: CONCEPT
 [id="installing-rhel-on-the-provisioner-node_{context}"]
 = Installing {op-system-base} on the provisioner node


I think you did good work here and the module sucks to work with. Changing the content type to a CONCEPT is a good idea. I think one thing to be extra safe here is to change this title so it doesn't use a gerund like our procedure titles do:

Suggested change

= Installing {op-system-base} on the provisioner node

= {op-system-base} installations on the provisioner node

skopacz1 · 2026-08-06T17:29:48Z


-Perform the following steps to prepare the environment.
+[role="_abstract"]
+Before you proceed, perform the following steps to prepare the environment.


Can't have the abstract be self referential, maybe something like this instead:

Suggested change

Before you proceed, perform the following steps to prepare the environment.

Begin to set up your environment for cluster installation by preparing the provisioner node.

skopacz1 · 2026-08-06T17:30:41Z

 [NOTE]
 ====
-For more information about Red Hat Subscription Manager, see link:https://docs.redhat.com/en/documentation/subscription_central/1-latest/html/getting_started_with_rhel_system_registration/basic-reg-rhel-cli[Registering a {op-system-base} system with command-line tools].
+For more information about Red Hat Subscription Manager, see "Registering a {op-system-base} system with command-line tools".


This is a procedure module, which can keep its external links like these. I would revert the removal of this link and the one further down in the file

skopacz1 · 2026-08-06T17:33:43Z

 [source,terminal,subs="attributes+"]
 ----
 $ export VERSION=stable-{product-version}
 ----
 [source,terminal,subs="attributes+"]
 ----
 $ export RELEASE_ARCH=<architecture>
 ----
 [source,terminal,subs="attributes+"]


This procedure sucks to have to work with, and I think you did a decent job. But this is a case where I think we need to carefully format this to be more like a proper procedure instead of making it a concept. So I would revert the content type change above and then modify this part like so:

Suggested change

.Procedure

* Retrieve the installation program by running one of the following commands:

+

[source,terminal,subs="attributes+"]

----

$ export VERSION=stable-{product-version}

----

+

[source,terminal,subs="attributes+"]

----

$ export RELEASE_ARCH=<architecture>

----

+

[source,terminal,subs="attributes+"]

skopacz1 · 2026-08-06T17:34:18Z

 // * installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc

-:_mod-docs-content-type: PROCEDURE
+:_mod-docs-content-type: CONCEPT


Reversion based on my advice below:

Suggested change

:_mod-docs-content-type: CONCEPT

:_mod-docs-content-type: PROCEDURE

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

ocpdocs-vale-bot reviewed Aug 5, 2026

View reviewed changes

Comment thread modules/ipi-install-configuring-the-install-config-file.adoc

ocpdocs-vale-bot reviewed Aug 5, 2026

View reviewed changes

Comment thread modules/ipi-install-configuring-the-install-config-file.adoc

ocpdocs-vale-bot reviewed Aug 5, 2026

View reviewed changes

Comment thread modules/ipi-install-configuring-the-install-config-file.adoc

ocpdocs-vale-bot reviewed Aug 5, 2026

View reviewed changes

Comment thread modules/ipi-install-installing-rhel-on-the-provisioner-node.adoc

rh-sgehlot force-pushed the OSDOCS#17012_bare_metal_ipi_1 branch from 178c6d2 to 4f647e9 Compare August 5, 2026 15:34

OSDOCS#17012_workflow_pr1_2

dba3672

rh-sgehlot force-pushed the OSDOCS#17012_bare_metal_ipi_1 branch from 4f647e9 to dba3672 Compare August 5, 2026 15:35

skopacz1 reviewed Aug 6, 2026

View reviewed changes

	Review the different methods for installing {product-title} on bare metal and setup your environment for installation.
	Before you can install an {product-title} cluster on bare metal, you must set up your environment for installation.

	= Installing {op-system-base} on the provisioner node
	= {op-system-base} installations on the provisioner node

	Before you proceed, perform the following steps to prepare the environment.
	Begin to set up your environment for cluster installation by preparing the provisioner node.

	:_mod-docs-content-type: CONCEPT
	:_mod-docs-content-type: PROCEDURE

Uh oh!

Conversation

rh-sgehlot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openshift-ci Bot commented Aug 5, 2026

Uh oh!

skopacz1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rh-sgehlot commented Aug 5, 2026 •

edited

Loading

ocpdocs-previewbot commented Aug 5, 2026 •

edited

Loading