RHIDP-6150: Move links in Prerequisites to Additional resources-Installation Guide #1242
Conversation
jmagak
added
Peer review needed 📖
do-no-merge/review-in-progress 👀
Technical review needed 🔩
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1242/ @ 07/01/25 17:07:39 |
jmagak
force-pushed
the
RHIDP-6150-Move-links-in-Prerequisites-to-Additional-Resources
branch
from
54ee6c3 to
de64c6e
Compare
jmagak
force-pushed
the
RHIDP-6150-Move-links-in-Prerequisites-to-Additional-Resources
branch
from
de64c6e to
a4f17e9
Compare
There was a problem hiding this comment.
@jmagak Thank you for working on this Jira. I appreciate your effort on this. However, I feel we may not be heading in quite the right direction here, as all the relevant links are currently being moved to a separate section instead of being placed alongside the appropriate introductory statements.
To give you more context on RHIDP-6150 — this Jira was primarily created for the Installation Using OCP guide. Please see the attached screenshot for reference.
Placing all the reference links only under Additional resources could create confusion for users, as they would then have to look elsewhere for the necessary context.
If you’d like, we can have a quick chat — I’d be happy to share more detailed content and suggest a clearer direction for this task.
| @@ -8,12 +8,12 @@ | |||
| .Prerequisites | |||
|
|
|||
| * A cluster administrator has installed the {product} Operator. | |||
| * You have an {eks-short} cluster with {aws-short} Application Load Balancer (ALB) add-on installed. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html[Application load balancing on {eks-brand-name}] and https://docs.aws.amazon.com/eks/latest/userguide/aws-load-balancer-controller.html[Installing the AWS Load Balancer Controller add-on]. | |||
| * You have configured a domain name for your {product-short} instance. The domain name can be a hosted zone entry on Route 53 or managed outside of AWS. For more information, see https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html[Configuring Amazon Route 53 as your DNS service] documentation. | |||
| * You have installed an {eks-short} cluster with {aws-short} Application Load Balancer (ALB) add-on. | |||
There was a problem hiding this comment.
I’m not sure I understand the reason for this change. We’re removing references to additional resources, but I feel the Additional resources section should include only RHDH links, and any other resources could be added alongside the relevant introductory statement. Could you please clarify?
| @@ -158,3 +158,13 @@ In the previous template, replace ` <rhdh_dns_name>` with your {product-short} d | |||
| .Verification | |||
|
|
|||
| Wait until the DNS name is responsive, indicating that your {product-short} instance is ready for use. | |||
|
|
|||
| [role="_additional-resources"] | |||
| .Additional resources | |||
There was a problem hiding this comment.
I don’t think these reference links, including the external ones, are best placed here. It might be better to add them back to the Prerequisites section with clear introductory statements, similar to how it’s done in the OCP documentation.
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s): 1.5, 1.6, 1.7
Issue: RHIDP-6150
Preview:
install-rhdh-air-gapped
install-rhdh-aks
install-rhdh-eks
install-rhdh-gke
install-rhdh-ocp
install-rhdh-osd-gcp