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

$ sing is missing from the command

Open prithvipatil97 opened this issue 5 months ago • 4 comments

$ sing is missing from the documentation.

  • Here is the documentation link: https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/storage/using-container-storage-interface-csi#persistent-storage-csi-sc-managing-cli_persistent-storage-csi-sc-manage

Here is the current documentation look:

  • To manage the storage class using the CLI, run the following command:
oc patch clustercsidriver $DRIVERNAME --type=merge -p "{\"spec\":{\"storageClassState\":\"${STATE}\"}}"
  • $ sign is missing in the above command.
  • It will not cause any issue.
  • But as per standard procedure $ sign should be present at the start of command.

Here is the updated look of the documentation.

  • To manage the storage class using the CLI, run the following command:
$ oc patch clustercsidriver $DRIVERNAME --type=merge -p "{\"spec\":{\"storageClassState\":\"${STATE}\"}}"

Version(s):

RHOCP 4.20, RHOCP 4.19, RHOCP 4.18, RHOCP 4.17, RHOCP 4.16, RHOCP 4.15, RHOCP 4.14, RHOCP 4.13

Issue:

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

Link to docs preview:

https://95288--ocpdocs-pr.netlify.app/openshift-dedicated/latest/storage/container_storage_interface/persistent-storage-csi-sc-manage.html https://95288--ocpdocs-pr.netlify.app/openshift-enterprise/latest/storage/container_storage_interface/persistent-storage-csi-sc-manage.html https://95288--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/storage/container_storage_interface/persistent-storage-csi-sc-manage.html https://95288--ocpdocs-pr.netlify.app/openshift-rosa/latest/storage/container_storage_interface/persistent-storage-csi-sc-manage.html

QE review:

  • [ ] QE has approved this change.

Additional information:

prithvipatil97 avatar Jun 26 '25 14:06 prithvipatil97

🤖 Thu Jun 26 14:43:59 - Prow CI generated the docs preview:

https://95288--ocpdocs-pr.netlify.app/openshift-dedicated/latest/storage/container_storage_interface/persistent-storage-csi-sc-manage.html https://95288--ocpdocs-pr.netlify.app/openshift-enterprise/latest/storage/container_storage_interface/persistent-storage-csi-sc-manage.html https://95288--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/storage/container_storage_interface/persistent-storage-csi-sc-manage.html https://95288--ocpdocs-pr.netlify.app/openshift-rosa/latest/storage/container_storage_interface/persistent-storage-csi-sc-manage.html

ocpdocs-previewbot avatar Jun 26 '25 14: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 26 '25 14:06 openshift-ci[bot]

/label peer-review-needed

prithvipatil97 avatar Jun 26 '25 15:06 prithvipatil97

/label peer-review-in-progress

jneczypor avatar Jun 26 '25 16:06 jneczypor

Hello Team, I need QE approval for this change.

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

It would be really helpful if someone could please take a look and provide QE approval for this change.

cc: @Phaow @duanwei33, @ropatil010

Regards, Prithviraj Patil

prithvipatil97 avatar Jul 02 '25 21:07 prithvipatil97

/lgtm

ropatil010 avatar Jul 09 '25 05:07 ropatil010

/label merge-review-needed

prithvipatil97 avatar Jul 09 '25 12:07 prithvipatil97

/cherrypick enterprise-4.13 /cherrypick enterprise-4.14 /cherrypick enterprise-4.15 /cherrypick enterprise-4.16 /cherrypick enterprise-4.17 /cherrypick enterprise-4.18 /cherrypick enterprise-4.19 /cherrypick enterprise-4.20

mburke5678 avatar Jul 09 '25 14:07 mburke5678

@mburke5678: new pull request created: #95812

In response to this:

/cherrypick enterprise-4.13 /cherrypick enterprise-4.14 /cherrypick enterprise-4.15 /cherrypick enterprise-4.16 /cherrypick enterprise-4.17 /cherrypick enterprise-4.18 /cherrypick enterprise-4.19 /cherrypick enterprise-4.20

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.

@mburke5678: new pull request created: #95813

In response to this:

/cherrypick enterprise-4.13 /cherrypick enterprise-4.14 /cherrypick enterprise-4.15 /cherrypick enterprise-4.16 /cherrypick enterprise-4.17 /cherrypick enterprise-4.18 /cherrypick enterprise-4.19 /cherrypick enterprise-4.20

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.

@mburke5678: new pull request created: #95814

In response to this:

/cherrypick enterprise-4.13 /cherrypick enterprise-4.14 /cherrypick enterprise-4.15 /cherrypick enterprise-4.16 /cherrypick enterprise-4.17 /cherrypick enterprise-4.18 /cherrypick enterprise-4.19 /cherrypick enterprise-4.20

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.

@mburke5678: new pull request created: #95816

In response to this:

/cherrypick enterprise-4.13 /cherrypick enterprise-4.14 /cherrypick enterprise-4.15 /cherrypick enterprise-4.16 /cherrypick enterprise-4.17 /cherrypick enterprise-4.18 /cherrypick enterprise-4.19 /cherrypick enterprise-4.20

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.

@mburke5678: new pull request created: #95821

In response to this:

/cherrypick enterprise-4.13 /cherrypick enterprise-4.14 /cherrypick enterprise-4.15 /cherrypick enterprise-4.16 /cherrypick enterprise-4.17 /cherrypick enterprise-4.18 /cherrypick enterprise-4.19 /cherrypick enterprise-4.20

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.

@mburke5678: new pull request created: #95824

In response to this:

/cherrypick enterprise-4.13 /cherrypick enterprise-4.14 /cherrypick enterprise-4.15 /cherrypick enterprise-4.16 /cherrypick enterprise-4.17 /cherrypick enterprise-4.18 /cherrypick enterprise-4.19 /cherrypick enterprise-4.20

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.

@mburke5678: new pull request created: #95826

In response to this:

/cherrypick enterprise-4.13 /cherrypick enterprise-4.14 /cherrypick enterprise-4.15 /cherrypick enterprise-4.16 /cherrypick enterprise-4.17 /cherrypick enterprise-4.18 /cherrypick enterprise-4.19 /cherrypick enterprise-4.20

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.

@mburke5678: new pull request created: #95827

In response to this:

/cherrypick enterprise-4.13 /cherrypick enterprise-4.14 /cherrypick enterprise-4.15 /cherrypick enterprise-4.16 /cherrypick enterprise-4.17 /cherrypick enterprise-4.18 /cherrypick enterprise-4.19 /cherrypick enterprise-4.20

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.