-
Bug
-
Resolution: Unresolved
-
Normal
-
None
-
OpenShift 4.18 Async, OpenShift 4.19 Async, OpenShift 4.20 Async, OpenShift 4.21 Async
-
False
-
-
False
-
-
-
Moderate
- Google Cloud Storage documentation command structure is wrong
- Here is the documentation link: https://docs.redhat.com/en/documentation/red_hat_openshift_cluster_observability_operator/1-latest/html/installing_red_hat_openshift_cluster_observability_operator/installing-end-to-end-observability-services#google-cloud-storage
- Current documentation code block looks:
$ oc -n $NAMESPACE create secret generic gcs-secret \ --from-file=key.json="$GCS_KEY_FILE_PATH"
$ oc create secret generic storage-secret \ --from-literal=bucketname="<BUCKET_NAME>" \ --from-literal=key.json="<PATH_TO_JSON_KEY_FILE>"
$ oc -n $NAMESPACE create secret generic gcs-secret \ --from-file=key.json="$GCS_KEY_FILE_PATH"
- In the above commands, the "- " signs are incorrectly placed below the "$" symbol.
- However, they should be aligned parallel to the "oc" command, where the command begins.
- Here is the updated look for all these code blocks:
$ oc -n $NAMESPACE create secret generic gcs-secret \ --from-file=key.json="$GCS_KEY_FILE_PATH"
$ oc create secret generic storage-secret \ --from-literal=bucketname="<BUCKET_NAME>" \ --from-literal=key.json="<PATH_TO_JSON_KEY_FILE>"
$ oc -n $NAMESPACE create secret generic gcs-secret \ --from-file=key.json="$GCS_KEY_FILE_PATH"
- The commands will work as it is, but the structure is incorrect.
- It should be a standard format all over the documentation. Hence, it needs to be changed.
