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

Update persistent-storage-csi-vol-detach-non-graceful-shutdown-proced…

Open prithvipatil97 opened this issue 4 months ago • 7 comments

  • Incorrect structure in the OpenShift documentation

  • Here is the documentation link: https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/storage/ephemeral-storage-csi-vol-detach-non-graceful-shutdown#persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure_ephemeral-storage-csi-vol-detach-non-graceful-shutdown

  • $ sign is missing from every command.

  • is mentioned without an underscore.

Following changes are required:

  1. Need to add $ sign at the start of each command.
  2. Need to mention underscore between
  3. Need to add <node_name> value for 1

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-2047

Link to docs preview:

QE review:

  • [ ] QE has approved this change.

https://95410--ocpdocs-pr.netlify.app/openshift-enterprise/latest/storage/persistent-storage-csi-vol-detach-non-graceful-shutdown.html

Additional information:

prithvipatil97 avatar Jun 28 '25 13:06 prithvipatil97

🤖 Tue Jul 01 13:12:56 - Prow CI generated the docs preview:

https://95410--ocpdocs-pr.netlify.app/openshift-enterprise/latest/storage/persistent-storage-csi-vol-detach-non-graceful-shutdown.html

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

/label peer-review-needed

prithvipatil97 avatar Jun 28 '25 13:06 prithvipatil97

/label peer-review-in-progress

aspauldi avatar Jun 30 '25 17:06 aspauldi

Hi, I added a suggestion for rewording the callout text, hoping to make it less awkward. (I realize though that your update was just to use the underscore, so consider the rewrite but I understand if you prefer not to make the changes.)

Overall LGTM!

aspauldi avatar Jun 30 '25 17:06 aspauldi

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

aspauldi avatar Jun 30 '25 17:06 aspauldi

Make sure to add the link to the preview in your description. Thank you!

eohartman avatar Jun 30 '25 17:06 eohartman

@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 Jul 01 '25 13:07 openshift-ci[bot]

Hello @eohartman , Thanks for the peer review and suggestions. I have successfully committed the suggested changes. Now, I will ask for QE approval.

Regards, Prithviraj Patil

prithvipatil97 avatar Jul 02 '25 21:07 prithvipatil97

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 19:07 mburke5678

@mburke5678: #95410 failed to apply on top of branch "enterprise-4.13":

Applying: Update persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc
Using index info to reconstruct a base tree...
M	modules/persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc
CONFLICT (content): Merge conflict in modules/persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 Update persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc

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.

/cherrypick enterprise-4.14

mburke5678 avatar Jul 09 '25 19:07 mburke5678

@mburke5678: #95410 failed to apply on top of branch "enterprise-4.14":

Applying: Update persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc
Using index info to reconstruct a base tree...
M	modules/persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc
CONFLICT (content): Merge conflict in modules/persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 Update persistent-storage-csi-vol-detach-non-graceful-shutdown-procedure.adoc

In response to this:

/cherrypick 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.

/cherrypick enterprise-4.15

mburke5678 avatar Jul 09 '25 19:07 mburke5678

/cherrypick enterprise-4.16

mburke5678 avatar Jul 09 '25 19:07 mburke5678

/cherrypick enterprise-4.17

mburke5678 avatar Jul 09 '25 19:07 mburke5678

/cherrypick enterprise-4.18

mburke5678 avatar Jul 09 '25 19:07 mburke5678

/cherrypick enterprise-4.19

mburke5678 avatar Jul 09 '25 19:07 mburke5678

/cherrypick enterprise-4.20

mburke5678 avatar Jul 09 '25 19:07 mburke5678

@mburke5678: new pull request created: #95851

In response to this:

/cherrypick enterprise-4.15

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: #95852

In response to this:

/cherrypick enterprise-4.16

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: #95853

In response to this:

/cherrypick enterprise-4.17

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: #95854

In response to this:

/cherrypick enterprise-4.18

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: #95855

In response to this:

/cherrypick enterprise-4.19

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: #95856

In response to this:

/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.