Skip to content

[WIP] OSDOCS-16402: CQA fixes for ROSA HCP Tutorials (part 1)#113885

Open
otikhomi wants to merge 1 commit into
openshift:mainfrom
otikhomi:OSDOCS-16402-cqa-rosa-hcp-tutorials
Open

[WIP] OSDOCS-16402: CQA fixes for ROSA HCP Tutorials (part 1)#113885
otikhomi wants to merge 1 commit into
openshift:mainfrom
otikhomi:OSDOCS-16402-cqa-rosa-hcp-tutorials

Conversation

@otikhomi

@otikhomi otikhomi commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Version(s):
4.22+
5.0+

Issue:
Main ROSA HCP Tutorials CQA ticket: https://redhat.atlassian.net/browse/OSDOCS-16402
Bug tickets:

Link to docs preview:

QE review:
N/A

Additional information:

CQA fixes for ROSA HCP Tutorials will be split into 2 PRs.
This PR 1 fixes:

  • CQA section: Procedures (only 1 procedure has a Prereqs section and it's correct).
  • CQA section: Editorial (grammar and content types)
  • CQA section: URLs and links (4 broken links)
  • CQA section: Legal and Branding (updated ROSA, ROSA CLI, OC CLI, and OADP attributes and spelling)
  • Gerunds in titles
  • Abbreviations not expanded on first use: OADP, DPA, BYO VPC, ACL, WAF, ARN, CFI, and PVs.

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

openshift-ci-robot commented Jun 22, 2026

Copy link
Copy Markdown

@otikhomi: This pull request references OSDOCS-16402 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 story to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Version(s):
4.22+
5.0+

Issue:
Main ROSA HCP Tutorials CQA ticket: https://redhat.atlassian.net/browse/OSDOCS-16402
Bug tickets:

Link to docs preview:

QE review:
N/A

Additional information:

CQA fixes for ROSA HCP Tutorials will be split into 2 PRs.
This PR 1 fixes:

  • CQA section: Procedures (only 1 procedure has a Prereqs section and it's correct).
  • CQA section: Editorial (grammar and content types)
  • CQA section: URLs and links (4 broken links)
  • Gerunds in titlesCQA section: Legal and Branding (updated ROSA, ROSA CLI, OC CLI, and OADP attributes and spelling)
  • Abbreviations not expanded on first use: OADP, DPA, BYO VPC, ACL, WAF, ARN, CFI, and PVs.

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 Jun 22, 2026
@ocpdocs-previewbot

Copy link
Copy Markdown

🤖 Mon Jun 22 22:58:08 - Prow CI generated the docs preview:
https://113885--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

[TIP]
====
Load Balancers created by the AWS Load Balancer Operator cannot be used for xref:../networking/ingress_load_balancing/routes/nw-configuring-routes.adoc#route-configuration[OpenShift Routes], and should only be used for individual services or ingress resources that do not need the full layer 7 capabilities of an OpenShift Route.
Load Balancers created by the AWS Load Balancer Operator cannot be used for xref:../networking/ingress_load_balancing/routes/nw-configuring-routes.adoc#nw-configuring-routes[{OCP-short} Routes], and should only be used for individual services or ingress resources that do not need the full layer 7 capabilities of an {OCP-short} Route.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.

ifndef::openshift-rosa-hcp[]
// Assembly configuring-egress-ips-ovn is commented out of the ROSA HCP topic map (as of June 2026).
ifdef::openshift-rosa[]
See xref:../networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc#configuring-egress-ips-ovn[Configuring an egress IP address] for more information.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.

* The xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI] (`oc`)
* The xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[ROSA CLI] (`rosa`)
* link:https://stedolan.github.io/jq/[`jq`]
* The xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[{oc-first}]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.

* The xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[ROSA CLI] (`rosa`)
* link:https://stedolan.github.io/jq/[`jq`]
* The xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[{oc-first}]
* The xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[{rosa-cli-first}]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.

* link:https://stedolan.github.io/jq/[`jq`]
* The xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[{oc-first}]
* The xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[{rosa-cli-first}]
* link:https://jqlang.org/[`jq`]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.


[role="_abstract"]
A link:https://docs.aws.amazon.com/vpc/latest/userguide/DHCPOptionSet.html[custom DHCP option set] enables you to customize your VPC with your own DNS server, domain name, and more. {product-title} clusters support using custom DHCP option sets. By default, {product-title} clusters require setting the "domain name servers" option to `AmazonProvidedDNS` to ensure successful cluster creation and operation. Customers who want to use custom DNS servers for DNS resolution must do additional configuration to ensure successful {product-title} cluster creation and operation.
A link:https://docs.aws.amazon.com/vpc/latest/userguide/DHCPOptionSet.html[custom Dynamic Host Configuration Protocol (DHCP) option set] enables you to customize your Virtual Private Cloud (VPC) with your own Domain Name System (DNS) server, domain name, and more. {product-title} clusters support using custom DHCP option sets. By default, {product-title} clusters require setting the "domain name servers" option to `AmazonProvidedDNS` to ensure successful cluster creation and operation. Customers who want to use custom DNS servers for DNS resolution must do additional configuration to ensure successful {product-title} cluster creation and operation.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.

A link:https://docs.aws.amazon.com/vpc/latest/userguide/DHCPOptionSet.html[custom Dynamic Host Configuration Protocol (DHCP) option set] enables you to customize your Virtual Private Cloud (VPC) with your own Domain Name System (DNS) server, domain name, and more. {product-title} clusters support using custom DHCP option sets. By default, {product-title} clusters require setting the "domain name servers" option to `AmazonProvidedDNS` to ensure successful cluster creation and operation. Customers who want to use custom DNS servers for DNS resolution must do additional configuration to ensure successful {product-title} cluster creation and operation.

In this tutorial, we will configure our DNS server to forward DNS lookups for specific DNS zones (further detailed below) to an link:https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver.html[Amazon Route 53 Inbound Resolver].
In this tutorial, we will configure our DNS server to forward DNS lookups for specific DNS zones (further detailed below) to an link:https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver.html[Amazon Route 53 Inbound Resolver].

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] AsciiDocDITA.ConceptLink: Move all links and cross references to Additional resources.

:_mod-docs-content-type: PROCEDURE
[id="cloud-experts-consistent-egress-ip-blocked-egress_{context}"]
= Optional: Testing blocked egress
= Optional: Test blocked egress

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 [error] OpenShiftAsciiDoc.NoOptionalTitles: Do not begin a module or assembly title with 'Optional:'.

@openshift-ci

openshift-ci Bot commented Jun 22, 2026

Copy link
Copy Markdown

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

Complete the prerequisites before starting the web console deployment process.

The `rosa` CLI is required for certain tasks, such as creating the account roles. If you are deploying {product-title} for the first time, follow this the CLI steps until running the `rosa whoami` command, before starting the web console deployment steps.
The `rosa` CLI is required for certain tasks, such as creating the account roles. If you are deploying {product-title} for the first time, follow the CLI steps until running the `rosa whoami` command, before starting the web console deployment steps.

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.

Do we keep rosa CLI in docs? Or should it always be ROSA CLI and hence {rosa-cli}.

@otikhomi otikhomi changed the title OSDOCS-16402: CQA fixes for ROSA HCP Tutorials (part 1) [WIP] OSDOCS-16402: CQA fixes for ROSA HCP Tutorials (part 1) Jun 23, 2026
@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants