Move links in Prerequisites to Additional resources

Move links in Prerequisites to Additional resources

Move links in Prerequisites to Additional resources

Move links in Prerequisites to Additional resources

Move links in Prerequisites to Additional resources

Author: GitHub Actions

modules/installation/proc-deploy-rhdh-instance-eks.adoc

@@ -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 an {eks-short} cluster with {aws-short} Application Load Balancer (ALB) add-on installed.
+* 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.
 * You have an entry in the {aws-short} Certificate Manager (ACM) for your preferred domain name. Make sure to keep a record of your Certificate ARN.
-* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
-* You have set the context to the {eks-short} cluster in your current `kubeconfig`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster].
-* You have installed `kubectl`. For more information, see https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Installing or updating kubectl].
+* You have subscribed to `registry.redhat.io`.
+* You have set the context to the {eks-short} cluster in your current `kubeconfig`.
+* You have installed `kubectl`.
 
 .Procedure
 
@@ -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
+
+* link:https://docs.aws.amazon.com/eks/latest/userguide/alb-ingress.html[Application load balancing on {eks-brand-name}]
+* link:https://docs.aws.amazon.com/eks/latest/userguide/aws-load-balancer-controller.html[Installing the AWS Load Balancer Controller add-on]
+* link:https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html[Configuring Amazon Route 53 as your DNS service documentation]
+* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]
+* link:https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html[Creating or updating a kubeconfig file for an Amazon {eks-short} cluster]
+* link:https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html[Installing or updating kubectl]

modules/installation/proc-deploy-rhdh-instance-gke.adoc

@@ -4,11 +4,10 @@ You can deploy your {product-short} instance in {gke-short} using the Operator.
 
 .Prerequisites
 * A cluster administrator has installed the {product} Operator.
-* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
-* You have installed `kubectl`. For more information, see https://kubernetes.io/docs/tasks/tools/#kubectl[Install kubetl].
-
+* You have subscribed to `registry.redhat.io`.
+* You have installed `kubectl`.
 * You have configured a domain name for your {product-short} instance.
-* You have reserved a static external Premium IPv4 Global IP address that is not attached to any virtual machine (VM). For more information see https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserve a new static external IP address]
+* You have reserved a static external Premium IPv4 Global IP address that is not attached to any virtual machine (VM).
 * You have configured the DNS records for your domain name to point to the IP address that has been reserved.
 +
 [NOTE]
@@ -191,5 +190,19 @@ spec:
 
 // Wait until the DNS name is responsive, indicating that your {product-short} instance is ready for use.
 
+[role="_additional-resources"]
+.Additional resources
+
+* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]
+* link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing `kubetl]`
+* link:https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserving a new static external IP address]
+
 .Additional information
 For more information on setting up {gke-short} using Ingress with TLS, see https://github.com/GoogleCloudPlatform/gke-networking-recipes/tree/main/ingress/single-cluster/ingress-https[Secure GKE Ingress].
+
+[role="_additional-resources"]
+.Additional resources
+
+* link:https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication]
+* link:https://kubernetes.io/docs/tasks/tools/#kubectl[Installing kubetl]
+* link:https://cloud.google.com/vpc/docs/reserve-static-external-ip-address#reserve_new_static[Reserving a new static external IP address]

modules/installation/proc-enable-signin.adoc

@@ -63,7 +63,6 @@ The {product} supports the following authentication providers:
 .Prerequisites
 
 * You have installed the {product-short}.
-For more information about installation, see xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart].
 
 .Procedure
 
@@ -87,3 +86,8 @@ auth:
 `signInPage: oidc`
 
 . Start your {product-short} application and sign in.
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:{installing-on-ocp-book-url}#assembly-install-rhdh-ocp-helm[{installing-on-ocp-book-title} with the Helm chart]

modules/installation/proc-install-operator.adoc

@@ -14,7 +14,7 @@ Containers are available for the following CPU architectures:
 .Prerequisites
 
 * You are logged in as an administrator on the {ocp-short} web console.
-* You have configured the appropriate roles and permissions within your project to create or access an application. For more information, see the link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications].
+* You have configured the appropriate roles and permissions within your project to create or access an application.
 * You have installed {ocp-brand-name} 4.17 or later.
 
 .Procedure
@@ -81,5 +81,6 @@ If you selected an *Automatic* approval strategy, the upgrade status should reso
 [role="_additional-resources"]
 .Additional resources
 
-* xref:proc-install-rhdh-ocp-operator_{context}[Deploying {product} on {ocp-short} with the Operator]
+* xref:proc-install-rhdh-ocp-operator_{context}[Deploying {product} on {ocp-short} with Operator]
 * link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/operators/index#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub by using the web console]
+* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-brand-name} documentation on Building applications]

modules/installation/proc-install-rhdh-airgapped-partial-k8s-helm.adoc

@@ -5,7 +5,7 @@ In a partially disconnected environment, the cluster cannot access external regi
 
 .Prerequisites
 
-* You have set up your workstation.
+* You have set up your workstation
 ** You have installed Skopeo 1.17 or later
 ** You have installed Yq 4.4 or later
 ** You have installed Helm 3.13 or later

modules/installation/proc-install-rhdh-helm-airgapped-full.adoc

@@ -9,11 +9,11 @@ If your network has access to the registry through a bastion host, you can use t
 ** You have access to the registry.redhat.io.
 ** You have access to the charts.openshift.io Helm chart repository.
 ** You have installed the {openshift-cli} on your workstation.
-** You have installed the oc-mirror {openshift-cli} plugin, for more information see https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin].
+** You have installed the oc-mirror {openshift-cli} plugin.
 ** You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal.
 * You have set up your intermediary host.
-** Your host has access to the disconnected cluster and to the target mirror registry, for example, the {ocp-brand-name} image registry. For more information about exposing the {ocp-short} image registry, see https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the registry].
-** You have installed the oc-mirror {openshift-cli} plugin, for more information see https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin].
+** Your host has access to the disconnected cluster and to the target mirror registry, for example, the {ocp-brand-name} image registry.
+** You have installed the oc-mirror {openshift-cli} plugin.
 ** You have installed {ocp-brand-name} {ocp-version-min} or later.
 ** You have installed the {openshift-cli} on your workstation.
 
@@ -146,4 +146,10 @@ where:
 `<archive_file>` :: Specifies the name of the archive file containing the resources that you want to mirror, for example, `redhat-developer-hub-1.4.1.tgz`.
 
 `<your_namespace>` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`.
---
+--
+
+[role="_additional-resources"]
+.Additional resources
+
+* link:https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin]
+* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the {ocp-short} image registry]

modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc

@@ -8,10 +8,10 @@ If your network has access to the `registry.redhat.io` registry and the `charts.
 * You have installed {ocp-brand-name} {ocp-version-min} or later.
 * You have access to the `charts.openshift.io` Helm chart repository.
 * You have access to the `registry.redhat.io`.
-* You have access to a mirror registry that can be reached from the disconnected cluster, for example, the {ocp-short} image registry. For more information about exposing the {ocp-short} image registry, see https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the registry].
-* You are logged in to your target mirror registry and have permissions to push images to it. For more information, see link:https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-adding-registry-pull-secret_installing-mirroring-disconnected[Configuring credentials that allow images to be mirrored].
+* You have access to a mirror registry that can be reached from the disconnected cluster, for example, the {ocp-short} image registry.
+* You are logged in to your target mirror registry and have permissions to push images to it.
 * You have installed the {openshift-cli} on your workstation.
-* You have installed the oc-mirror {openshift-cli} plugin, for more information see https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin].
+* You have installed the oc-mirror {openshift-cli} plugin.
 * You have an account in https://developers.redhat.com/[{rhdeveloper-name}] portal.
 
 .Procedure
@@ -33,11 +33,11 @@ kind: ImageSetConfiguration
 mirror:
   helm:
     repositories:
-      - name: _<repository_name>_ (1)
-        url: _<repository_url>_ (2)
+      - name: _<repository_name>_ # <1>
+        url: _<repository_url>_ # <2>
         charts:
-          - name: _<chart_name>_ (3)
-            version: "_<rhdh_version>_" (4)
+          - name: _<chart_name>_ # <3>
+            version: "_<rhdh_version>_" # <4>
 ----
 <1> The name of the repository containing the Helm chart that you want to mirror, for example, `openshift-charts`.
 <2> The URL for the repository containing the Helm chart that you want to mirror, for example, `https://charts.openshift.io`.
@@ -122,4 +122,10 @@ where:
 `<archive_file>` :: Specifies the name of the archive file containing the resources that you want to mirror, for example, `redhat-developer-hub-1.4.1.tgz`.
 
 `<your_namespace>` :: Specifies the namespace that you want to deploy the Helm chart to, for example, `{my-product-namespace}`.
---
+--
++
+[role="_additional-resources"]
+.Additional resources
+* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/registry/index#securing-exposing-registry[Exposing the {ocp-short} image registry]
+* link:https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-adding-registry-pull-secret_installing-mirroring-disconnected[Configuring credentials that allow images to be mirrored]
+* link:https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/installing-mirroring-disconnected.html#installation-oc-mirror-installing-plugin_installing-mirroring-disconnected[Installing the oc-mirror OpenShift CLI plugin]

modules/installation/proc-install-rhdh-ocp-helm-cli.adoc

@@ -9,8 +9,8 @@ You can use the Helm CLI to install {product} on {ocp-brand-name}.
 .Prerequisites
 * You have installed the {openshift-cli} on your workstation.
 * You are logged in to your {ocp-short} account.
-* A user with the {ocp-short} admin role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions].
-* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation].
+* A user with the {ocp-short} admin role has configured the appropriate roles and permissions within your project to create an application.
+* You have created a project in {ocp-short}.
 * You have installed the Helm CLI tool.
 
 .Procedure
@@ -49,5 +49,8 @@ echo "https://redhat-developer-hub-$NAMESPACE.$CLUSTER_ROUTER_BASE"
 .Verification
 * Open the running {product-short} instance URL in your browser to use {product-short}.
 
+[role="_additional-resources"]
 .Additional resources
-* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/building_applications/index#installing-helm[Installing Helm]
+* link:https://docs.redhat.com/en/documentation/openshift_dedicated/4/html-single/building_applications/index#installing-helm[Installing Helm]
+* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions]
+* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[Creating a project in {ocp-short}]

modules/installation/proc-install-rhdh-ocp-helm-gui.adoc

@@ -18,8 +18,8 @@ The {product} Helm chart is available in the Helm catalog on {osd-short} and {oc
 .Prerequisites
 
 * You are logged in to your {ocp-short} account.
-* A user with the {ocp-short} `admin` role has configured the appropriate roles and permissions within your project to create an application. For more information about {ocp-short} roles, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions].
-* You have created a project in {ocp-short}. For more information about creating a project in {ocp-short}, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[{ocp-brand-name} documentation].
+* A user with the {ocp-short} `admin` role has configured the appropriate roles and permissions within your project to create an application.
+* You have created a project in {ocp-short}.
 
 .Procedure
 
@@ -76,3 +76,9 @@ Backend failed to start up Error: Missing required config value at 'backend.data
 
 To resolve the error, verify the configuration files.
 ====
+
+[role="_additional-resources"]
+.Additional resources
+
+* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/authentication_and_authorization/index#authorization-overview_using-rbac[Using RBAC to define and apply permissions]
+* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#working-with-projects[Creating a project in {ocp-short}]

modules/installation/proc-install-rhdh-ocp-operator.adoc

@@ -8,9 +8,9 @@ As a developer, you can deploy a {product} instance on {ocp-short} by using the
 
 .Prerequisites
 
-* xref:proc-install-operator_{context}[An {ocp-short} administrator has installed the {product} Operator].
-* xref:{configuring-book-url}#provisioning-your-custom-configuration[You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project].
-* xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[You have authored your {product-custom-resource-type} custom resource].
+* An {ocp-short} administrator has installed the {product} Operator.
+* You have provisioned your custom config maps and secrets in your `_<{my-product-namespace}>_` project.
+* You have authored your {product-custom-resource-type} custom resource.
 
 .Procedure
 
@@ -37,3 +37,10 @@ image::rhdh/operator-install-1.png[]
 [id="additional-resources_proc-install-rhdh-ocp-operator"]
 .Additional resources
 * link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html-single/building_applications/index#building-applications-overview[{ocp-short} - Building applications overview]
+* xref:proc-install-operator_{context}[{ocp-short} - Installing the {product} Operator]
+* xref:{configuring-book-url}#provisioning-your-custom-configuration[Provisioning your custom config maps and secrets in your `_<{my-product-namespace}>_` project]
+* xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[Authoring your {product-custom-resource-type} custom resource]
+
+* xref:proc-install-operator_{context}[{ocp-short} - Installing the {product} Operator]
+* xref:{configuring-book-url}#provisioning-your-custom-configuration[Provisioning your custom config maps and secrets in your `_<{my-product-namespace}>_` project]
+* xref:{configuring-book-url}#using-the-operator-to-run-rhdh-with-your-custom-configuration[Authoring your {product-custom-resource-type} custom resource]