openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

Update logging-loki-storage-azure.adoc

Open prithvipatil97 opened this issue 7 months ago • 9 comments

  • Incorrect command structure in the Azure Object Store documentation.
  • Here is the documentation link: https://docs.redhat.com/en/documentation/openshift_container_platform/4.15/html/logging/log-storage-3#logging-loki-storage-azure_installing-log-storage Here is the current documentation look:

You can create the Loki object storage secret manually by running the following command:

$ oc -n openshift-logging create secret generic logging-loki-azure \
--from-literal=environment="<azure_environment>" \
--from-literal=account_name="<storage_account_name>" \
--from-literal=container="<container_name>" 
  • In the above command, the "- -" signs are incorrectly placed below the "$" symbol.
  • However, it should be aligned parallel to the "oc" command, where the command begins.

Here is the updated look for all these commands:

$ oc -n openshift-logging create secret generic logging-loki-azure \
  --from-literal=environment="<azure_environment>" \
  --from-literal=account_name="<storage_account_name>" \
  --from-literal=container="<container_name>" 
  • The commands will work as it is, but the structure is incorrect.
  • It should be a standard format all over the documentation.

Version(s):

RHOCP 4.15, RHOCP 4.14

Issue:

https://issues.redhat.com/browse/OBSDOCS-2048

Link to docs preview:

https://95411--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/log_storage/installing-log-storage.html

QE review:

  • [ ] QE has approved this change.

Additional information:

prithvipatil97 avatar Jun 28 '25 14:06 prithvipatil97

🤖 Sat Jun 28 15:06:25 - Prow CI generated the docs preview:

https://95411--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/logging/log_storage/installing-log-storage.html

ocpdocs-previewbot avatar Jun 28 '25 15:06 ocpdocs-previewbot

@prithvipatil97: 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.

openshift-ci[bot] avatar Jun 28 '25 15:06 openshift-ci[bot]

/label peer-review-needed

prithvipatil97 avatar Jun 28 '25 20:06 prithvipatil97

/label peer-review-in-progress

aspauldi avatar Jun 30 '25 13:06 aspauldi

LGTM!

Just one comment about the link to the preview content--in the future, please link to the actual module/heading that has been updated to make it easier to find. Thank you!

aspauldi avatar Jun 30 '25 13:06 aspauldi

/remove-label peer-review-in-progress /remove-label peer-review-needed /label peer-review-done

aspauldi avatar Jun 30 '25 13:06 aspauldi

Hello Audrey, Thanks for reviewing this PR and providing approval.

prithvipatil97 avatar Jun 30 '25 13:06 prithvipatil97

Hello Team, I need QE approval for this change.

All checks have passed and the Peer review is also done.

@QiaolingTang, @anpingli , it would be really helpful if someone could please take a look and provide QE approval for this change.

Thanks in advance.

Regards, Prithviraj Patil

prithvipatil97 avatar Jun 30 '25 13:06 prithvipatil97

LGTM.

QiaolingTang avatar Jul 01 '25 00:07 QiaolingTang

/label merge-review-needed

prithvipatil97 avatar Jul 01 '25 07:07 prithvipatil97

/cherry-pick enterprise-4.14

stevsmit avatar Jul 01 '25 12:07 stevsmit

@stevsmit: new pull request created: #95475

In response to this:

/cherry-pick enterprise-4.14

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.