[enterprise-4.17] Incorrect structure of command in Edit the ClusterLogging custom resource (CR) step under multiple docs. #87119
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…urce (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:
1 task
openshift-ci
bot
added
the
size/XS
|
@openshift-cherrypick-robot: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an automated cherry-pick of #87031
/assign xenolinux