Apply suggestions from code review

rm3l · themr0c · rm3l · commit 028158b8853f · 2024-12-03T13:04:17.000+01:00
Co-authored-by: Fabrice Flore-Thébault &lt;ffloreth@redhat.com&gt;
diff --git a/modules/installation/proc-deploy-rhdh-instance-aks.adoc b/modules/installation/proc-deploy-rhdh-instance-aks.adoc
@@ -10,7 +10,7 @@
 * 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 set the context to the {aks-short} cluster in your current `kubeconfig`. For more information, see https://learn.microsoft.com/en-us/azure/aks/learn/quick-kubernetes-deploy-cli#connect-to-the-cluster[Connect to the cluster].
-* You have installed `kubectl`. For more information, see https://learn.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-install-cli[`az aks install-cli].
+* You have installed `kubectl`. For more information, see https://learn.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-install-cli[`az aks install-cli`].
 
 .Procedure
 
@@ -135,4 +135,4 @@ kubectl -n <your_namespace> apply -f rhdh.yaml
 
 .Verification
 
-Access the deployed {product-short} using the URL: `https://<app_address>`, where <app_address> is the Ingress address obtained earlier (for example, `https://108.141.70.228`).
+Access the deployed {product-short} using the URL: pass:c,a,q[{my-product-url}], where <app_address> is the Ingress address obtained earlier, such as pass:c,a,q[https://108.141.70.228].
diff --git a/modules/installation/proc-rhdh-deploy-aks-operator.adoc b/modules/installation/proc-rhdh-deploy-aks-operator.adoc
@@ -4,27 +4,22 @@
 [id='proc-rhdh-deploy-aks-operator_{context}']
 = Deploying {product-short} on {aks-short} with the Operator
 
-The {product} Operator installation requires the Operator Lifecycle Manager (OLM) framework.
-
-.Additonal resources
-* For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation.
-
-== Installing the {product-short} Operator with the OLM framework
-
 You can install the {product-short} Operator on {aks-short} using the https://olm.operatorframework.io[Operator Lifecycle Manager (OLM) framework]. Following that, you can proceed to deploy your {product-short} instance in {aks-short}.
 
+== Installing the {product-short} Operator
+
 .Prerequisites
 
 * You have cluster-scoped privileges.
 * You have set the context to the {aks-short} cluster in your current `kubeconfig`. For more information, see https://learn.microsoft.com/en-us/azure/aks/learn/quick-kubernetes-deploy-cli#connect-to-the-cluster[Connect to the cluster].
-* You have installed `kubectl`. For more information, see https://learn.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-install-cli[`az aks install-cli].
+* You have installed `kubectl`. For more information, see https://learn.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-install-cli[`az aks install-cli`].
 * You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
-* You have installed the Operator Lifecycle Manager (OLM). For more information about installation and troubleshooting, see https://olm.operatorframework.io/docs/getting-started/[OLM QuickStart] or https://operatorhub.io/how-to-install-an-operator#How-do-I-get-Operator-Lifecycle-Manager?[How do I get Operator Lifecycle Manager?]
+* You installed the Operator Lifecycle Manager (OLM) framework. See link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)].
 
 .Procedure
 
 // Procedure fragment on installing the operator using OLM on a non OCP cluster
-include::./proc-install-rhdh-operator-olm.adoc[]
+include::./snip-install-rhdh-operator-olm.adoc[]
 
 . Modify the default configuration of `db-statefulset.yaml` and `deployment.yaml` by adding the following fragment:
 +
diff --git a/modules/installation/proc-rhdh-deploy-eks-operator.adoc b/modules/installation/proc-rhdh-deploy-eks-operator.adoc
@@ -4,27 +4,22 @@
 [id='proc-rhdh-deploy-eks-operator_{context}']
 = Installing {product-short} on {eks-short} with the Operator
 
-The {product} Operator installation requires the Operator Lifecycle Manager (OLM) framework.
-
-.Additonal resources
-* For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation.
-
-== Installing the {product-short} Operator with the OLM framework
-
 You can install the {product-short} Operator on {eks-short} using the https://olm.operatorframework.io[Operator Lifecycle Manager (OLM) framework]. Following that, you can proceed to deploy your {product-short} instance in {eks-short}.
 
+== Installing the {product-short} Operator
+
 .Prerequisites
 
 * You have cluster-scoped privileges.
 * 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`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
-* You have installed the Operator Lifecycle Manager (OLM). For more information about installation and troubleshooting, see https://olm.operatorframework.io/docs/getting-started/[OLM QuickStart] or https://operatorhub.io/how-to-install-an-operator#How-do-I-get-Operator-Lifecycle-Manager?[How do I get Operator Lifecycle Manager?]
+* You installed the Operator Lifecycle Manager (OLM) framework. See link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)].
 
 .Procedure
 
 // Procedure fragment on installing the operator using OLM on a non OCP cluster
-include::./proc-install-rhdh-operator-olm.adoc[]
+include::./snip-install-rhdh-operator-olm.adoc[]
 
 .. Locate the `db-statefulset.yaml` string and add the `fsGroup` to its `spec.template.spec.securityContext`, as shown in the following example:
 +
diff --git a/modules/installation/snip-install-rhdh-operator-olm.adoc b/modules/installation/snip-install-rhdh-operator-olm.adoc
@@ -50,7 +50,7 @@ kubectl -n olm get packagemanifests
 ----
 --
 
-. Run the following command in your terminal to create the `rhdh-operator` namespace where the Operator is installed:
+. Create the `rhdh-operator` namespace aimed at containing the Operator:
 +
 --
 [source,terminal]
@@ -59,7 +59,7 @@ kubectl create namespace rhdh-operator
 ----
 --
 
-. Create a pull secret in the `rhdh-operator` namespace using the following command:
+. Create a pull secret in the `rhdh-operator` namespace:
 +
 --
 [source,terminal]
@@ -92,7 +92,7 @@ EOF
 ----
 --
 
-. Create a `Subscription` resource using the following code:
+. Create a `Subscription` resource:
 +
 --
 [source,terminal,subs="attributes+"]
@@ -114,7 +114,7 @@ EOF
 ----
 --
 
-. Run the following command to verify that the created Operator is running:
+. Verify that the created Operator is running:
 +
 --
 [source,terminal]
