From 6451194a1b5c7119c2c38e0dce144f58973d3974 Mon Sep 17 00:00:00 2001
From: Prithviraj Patil <116709298+prithvipatil97@users.noreply.github.com>
Date: Wed, 15 Jan 2025 01:40:06 +0530
Subject: [PATCH] Incorrect structure of command in Edit the ClusterLogging
 custom resource (CR) step under multiple docs.

- The structure of the command is incorrect in Edit the ClusterLogging custom resource (CR) step under multiple documents.
- Here is the one of the documentation link:
https://docs.openshift.com/container-platform/4.16/observability/logging/log_storage/logging-config-es-store.html#cluster-logging-elasticsearch-ha_logging-config-es-store
- Here in Step1 under the procedure section, we could see the below command is mentioned:
~~~
$ oc edit clusterlogging instance
~~~

- But this is not the correct way.
- The correct way to mention `clusterlogging` in the Red Hat Standard Documentation is `ClusterLogging`.
- We can verify this in the other part of our documentation.
- In addition, Step1 is noted with "Edit the ClusterLogging custom resource (CR) in the openshift-logging project:"
- However, the project name is not mentioned in the command.
- It is necessary to mention the project name while executing that command.

**Reason:**

1. Suppose the user is not a part of `openshift-logging` project, and he tries to run this command then this command will not work.
2. If the credentials are shared, and two people are using the same cluster at the same time, then, the second person could change to work in a different namespace.

- Hence it will be always beneficial to run the above command with the project name.
- We need to perform these changes in our documentation.
- Here is the correct structure of this command.
--------------------
1. Edit the ClusterLogging custom resource (CR) in the openshift-logging project:

~~~
$ oc -n openshift-logging edit ClusterLogging instance
~~~
--------------------

- We need to perform this changes in the following modules/section:
---
 modules/cluster-logging-elasticsearch-ha.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/modules/cluster-logging-elasticsearch-ha.adoc b/modules/cluster-logging-elasticsearch-ha.adoc
index 0f8058955c1c..448812244603 100644
--- a/modules/cluster-logging-elasticsearch-ha.adoc
+++ b/modules/cluster-logging-elasticsearch-ha.adoc
@@ -18,7 +18,7 @@ You can define how Elasticsearch shards are replicated across data nodes in the
 +
 [source,terminal]
 ----
-$ oc edit clusterlogging instance
+$ oc -n openshift-logging edit ClusterLogging instance
 ----
 +
 [source,yaml]