RHDEVDOCS-5954: Fixing typos in pre-reqs

openshift · Apr 23, 2024 · 0630c97 · 0630c97
1 parent d860b53
commit 0630c97
Show file tree

Hide file tree

Showing 14 changed files with 17 additions and 17 deletions.
diff --git a/accesscontrol_usermanagement/configuring-argo-cd-rbac.adoc b/accesscontrol_usermanagement/configuring-argo-cd-rbac.adoc
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-By default, if you are logged into Argo CD using Red Hat SSO (RH SSO), you are a read-only user. You can change and manage the user level access.
+By default, if you are logged in to Argo CD using Red Hat SSO (RH SSO), you are a read-only user. You can change and manage the user level access.
 
 // Configuring user level access
 include::modules/gitops-configuring-user-level-access.adoc[leveloffset=+1]

diff --git a/accesscontrol_usermanagement/configuring-sso-for-argo-cd-using-keycloak.adoc b/accesscontrol_usermanagement/configuring-sso-for-argo-cd-using-keycloak.adoc
@@ -11,7 +11,7 @@ After the {gitops-title} Operator is installed, Argo CD automatically creates a
 [id="prerequisites_configuring-sso-for-argo-cd-using-keycloak"]
 == Prerequisites
 * Red Hat SSO is installed on the cluster.
-* {gitops-title} Operator is installed on the cluster.
+* You have installed the {gitops-title} Operator on your {OCP} cluster.
 * Argo CD is installed on the cluster.
 
 // Configuring a new client in Keycloak

diff --git a/modules/gitops-additional-permissions-for-cluster-config.adoc b/modules/gitops-additional-permissions-for-cluster-config.adoc
@@ -9,8 +9,8 @@
 You can grant permissions for an Argo CD instance to manage cluster configuration. Create a cluster role with additional permissions and then create a new cluster role binding to associate the cluster role with a service account. 
 
 .Prerequisites
-* You have access to an {OCP} cluster with `cluster-admin` privileges and are logged into the web console.
-* You have installed the {gitops-title} Operator on your cluster.
+* You have access to an {OCP} cluster with `cluster-admin` privileges and are logged in to the web console.
+* You have installed the {gitops-title} Operator on your {OCP} cluster.
 
 .Procedure
 

diff --git a/modules/gitops-argo-cd-dynamic-scaling-by-using-cli.adoc b/modules/gitops-argo-cd-dynamic-scaling-by-using-cli.adoc
@@ -12,7 +12,7 @@
 You can enable dynamic scaling of shards by using the {oc-first}.
 
 .Prerequisites
-* You have installed the {gitops-title} Operator in your cluster.
+* You have installed the {gitops-title} Operator on your {OCP} cluster.
 * You have access to the cluster with `cluster-admin` privileges.
 
 .Procedure

diff --git a/modules/gitops-argo-cd-dynamic-scaling-in-web-console.adoc b/modules/gitops-argo-cd-dynamic-scaling-in-web-console.adoc
@@ -12,7 +12,7 @@ You can enable dynamic scaling of shards by using the {OCP} web console.
 .Prerequisites
 * You have access to the cluster with `cluster-admin` privileges.
 * You have access to the {OCP} web console.
-* You have installed the {gitops-title} Operator in your cluster.
+* You have installed the {gitops-title} Operator on your {OCP} cluster.
 
 .Procedure
 

diff --git a/modules/gitops-argo-cd-notification.adoc b/modules/gitops-argo-cd-notification.adoc
@@ -9,7 +9,7 @@
 Argo CD notifications allow you to send notifications to external services when events occur in your Argo CD instance. For example, you can send notifications to Slack or email when a sync operation fails. By default, notifications are disabled in Argo CD instances.
 
 .Prerequisites
-* You have access to an {OCP} cluster with `cluster-admin` privileges and are logged into the web console.
+* You have access to an {OCP} cluster with `cluster-admin` privileges and are logged in to the web console.
 * You have installed the {gitops-title} Operator on your cluster.
 
 .Procedure

diff --git a/modules/gitops-configuring-user-level-access.adoc b/modules/gitops-configuring-user-level-access.adoc
@@ -28,15 +28,15 @@ metadata
     scopes: '[groups]'
 ----
 +
-. Add the `policy` configuration to the `rbac` section and add the `name`, `email` and the `role` of the user: 
+. Add the `policy` configuration to the `rbac` section and add the `name` and the desired `role` to be applied to the user:
 +
 [source,yaml]
 ----
 metadata
 ...
 ...
 rbac:
-    policy: <name>, <email>, role:<admin>
+    policy: g, <name>, role:<admin>
     scopes: '[groups]'
 ----
 

diff --git a/modules/gitops-enabling-the-round-robin-sharding-algorithm-in-web-console.adoc b/modules/gitops-enabling-the-round-robin-sharding-algorithm-in-web-console.adoc
@@ -9,7 +9,7 @@
 You can enable the `round-robin` sharding algorithm by using the {OCP} web console.
 
 .Prerequisites
-* You have installed the {gitops-title} Operator in your cluster.
+* You have installed the {gitops-title} Operator on your {OCP} cluster.
 * You have access to the {OCP} web console.
 * You have access to the cluster with `cluster-admin` privileges.
 

diff --git a/modules/gitops-enabling-the-round-robin-sharding-algorithm-using-cli.adoc b/modules/gitops-enabling-the-round-robin-sharding-algorithm-using-cli.adoc
@@ -9,7 +9,7 @@
 You can enable the `round-robin` sharding algorithm by using the command-line interface.
 
 .Prerequisites
-* You have installed the {gitops-title} Operator in your cluster.
+* You have installed the {gitops-title} Operator on your {OCP} cluster.
 * You have access to the cluster with `cluster-admin` privileges.
 
 .Procedure

diff --git a/modules/gitops-storing-and-retrieving-argo-cd-logs.adoc b/modules/gitops-storing-and-retrieving-argo-cd-logs.adoc
@@ -10,8 +10,8 @@ You can use the Kibana dashboard to store and retrieve Argo CD logs.
 
 .Prerequisites
 
-* The {gitops-title} Operator is installed in your cluster.
-* The {logging-title} is installed with default configuration in your cluster.
+* You have installed the {gitops-title} Operator on your {OCP} cluster.
+* The {logging-title} is installed with default configuration on your {OCP}  cluster.
 
 .Procedure
 

diff --git a/modules/moving-the-gitops-operator-pod-to-infrastructure-nodes.adoc b/modules/moving-the-gitops-operator-pod-to-infrastructure-nodes.adoc
@@ -9,7 +9,7 @@
 You can move the {gitops-shortname} Operator pod to the infrastructure nodes.
 
 .Prerequisites
-* You have installed the {gitops-title} Operator in your cluster.
+* You have installed the {gitops-title} Operator on your {OCP} cluster.
 * You have access to the cluster with `cluster-admin` privileges.
 
 .Procedure

diff --git a/modules/proc_configuring-by-using-the-ocp-web-console.adoc b/modules/proc_configuring-by-using-the-ocp-web-console.adoc
@@ -10,7 +10,7 @@ You can configure the `NotificationsConfiguration` custom resource (CR) by using
 
 .Prerequisites
 
-* You have access to an {OCP} cluster with `cluster-admin` privileges and are logged into the web console.
+* You have access to an {OCP} cluster with `cluster-admin` privileges and are logged in to the web console.
 * You have installed the {gitops-title} Operator on your cluster.
 * You have enabled notifications for the Argo CD instance. For more information, see "Enabling notifications with an Argo CD instance".
 

diff --git a/observability/monitoring/monitoring-argo-cd-custom-resource-workloads.adoc b/observability/monitoring/monitoring-argo-cd-custom-resource-workloads.adoc
@@ -15,7 +15,7 @@ You can enable and disable the setting for monitoring Argo CD custom resource wo
 == Prerequisites
 
 * You have access to the cluster as a user with the `cluster-admin` role. 
-* {gitops-title} is installed in your cluster.
+* You have installed the {gitops-title} Operator on your {OCP} cluster.
 * The monitoring stack is configured in your cluster in the `openshift-monitoring` project. In addition, the Argo CD instance is in a namespace that you can monitor through Prometheus.
 * The `kube-state-metrics` service is running in your cluster.
 * Optional: If you are enabling monitoring for an Argo CD instance already present in a user-defined project, ensure that the monitoring is link:https://docs.openshift.com/container-platform/latest/monitoring/enabling-monitoring-for-user-defined-projects.html#enabling-monitoring-for-user-defined-projects_enabling-monitoring-for-user-defined-projects[enabled for user-defined projects] in your cluster.

diff --git a/observability/monitoring/monitoring-argo-cd-instances.adoc b/observability/monitoring/monitoring-argo-cd-instances.adoc
@@ -12,7 +12,7 @@ By default, the {gitops-title} Operator automatically detects an installed Argo
 == Prerequisites
 * You have access to the cluster with `cluster-admin` privileges.
 * You have access to the {OCP} web console.
-* You have installed the {gitops-title} Operator in your cluster.
+* You have installed the {gitops-title} Operator on your {OCP} cluster.
 * You have installed an Argo CD application in your defined namespace, for example, `openshift-gitops`.
 
 // Monitoring Argo CD health using Prometheus metrics