Skip to content

OBSDOCS-1941: Update storage-persistent-storage-reclaim-manual.adoc #93724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

prithvipatil97
Copy link
Contributor

@prithvipatil97 prithvipatil97 commented May 23, 2025

Here is the current documentation:

  1. Delete the PV.
$ oc delete pv <pv-name> 
  • Here <pv-name> is mentioned with hyphens.
  • But as per the standard format, it should be with underscores.
  • Also, full stop is mentioned after Delete the PV., but colon (:) is required here.

Here is the updated look:

  1. Delete the PV:
$ oc delete pv <pv_name>  

Version(s):

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

Link to docs preview:

https://93724--ocpdocs-pr.netlify.app/microshift/latest/microshift_storage/understanding-persistent-storage-microshift.html
https://93724--ocpdocs-pr.netlify.app/openshift-dedicated/latest/storage/understanding-persistent-storage.html
https://93724--ocpdocs-pr.netlify.app/openshift-enterprise/latest/storage/understanding-persistent-storage.html
https://93724--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/storage/understanding-persistent-storage.html
https://93724--ocpdocs-pr.netlify.app/openshift-rosa/latest/storage/understanding-persistent-storage.html

QE review:

  • QE has approved this change.

Additional information:

- one variable needs to be updated with underscores instead of hyphens.
- Here is the documentation:
https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/storage/understanding-persistent-storage#reclaim-manual_understanding-persistent-storage

Here is the current documentation:

1. Delete the PV.

$ oc delete pv <pv-name> 
Here `<pv-name> ` is mentioned with `underscores`.
But as per the standard format, it should be with `hyphens`.
Also, `full stop` is mentioned after `Delete the PV.`, but `colon` ( is required here.
Here is the updated look:

1. Delete the PV:
~~~
$ oc delete pv <pv_name>  
~~~
@openshift-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label May 23, 2025
Copy link

openshift-ci bot commented May 23, 2025

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

@prithvipatil97
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label May 23, 2025
@abrennan89 abrennan89 self-assigned this May 27, 2025
@abrennan89 abrennan89 added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels May 27, 2025
@abrennan89 abrennan89 added this to the Continuous Release milestone May 27, 2025
@abrennan89 abrennan89 changed the title Update storage-persistent-storage-reclaim-manual.adoc OBSDOCS-1941: Update storage-persistent-storage-reclaim-manual.adoc May 27, 2025
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 27, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented May 27, 2025

@prithvipatil97: This pull request references OBSDOCS-1941 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.20.0" version, but no target version was set.

In response to this:

Here is the current documentation:

  1. Delete the PV.
$ oc delete pv <pv-name> 
  • Here <pv-name> is mentioned with hyphens.
  • But as per the standard format, it should be with underscores.
  • Also, full stop is mentioned after Delete the PV., but colon (:) is required here.

Here is the updated look:

  1. Delete the PV:
$ oc delete pv <pv_name>  

Version(s):

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

Link to docs preview:

https://93724--ocpdocs-pr.netlify.app/microshift/latest/microshift_storage/understanding-persistent-storage-microshift.html
https://93724--ocpdocs-pr.netlify.app/openshift-dedicated/latest/storage/understanding-persistent-storage.html
https://93724--ocpdocs-pr.netlify.app/openshift-enterprise/latest/storage/understanding-persistent-storage.html
https://93724--ocpdocs-pr.netlify.app/openshift-rosa-hcp/latest/storage/understanding-persistent-storage.html
https://93724--ocpdocs-pr.netlify.app/openshift-rosa/latest/storage/understanding-persistent-storage.html

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@@ -19,11 +19,11 @@ endif::[]
.Procedure
To manually reclaim the PV as a cluster administrator:

. Delete the PV.
. Delete the PV:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. Delete the PV:
. Delete the PV by running the following command:

Steps in a procedure that have a command require an explicit instruction to enter or run the command, per https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#procedure-step-that-introduces-a-command

@abrennan89
Copy link
Contributor

@abrennan89 abrennan89 added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels May 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. peer-review-done Signifies that the peer review team has reviewed this PR size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants