[OSDOCS#16812]:Updated the Deleting your cluster assembly_CQA jobs#108791
[OSDOCS#16812]:Updated the Deleting your cluster assembly_CQA jobs#108791jheraght wants to merge 1 commit intoopenshift:mainfrom
Conversation
|
🤖 Fri Mar 20 16:30:32 - Prow CI generated the docs preview: |
|
@jheraght: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
| toc::[] | ||
| [role="_abstract"] | ||
| You can delete your {product-title} cluster using either the {rosa-cli-first} or the user interface (UI). | ||
| You might want to delete your {product-title} cluster in certain situations, such as if it fails to install properly, encounters errors during provisioning, or if it was set up for testing purposes only. You can delete your cluster using either the {rosa-cli-first} or the user interface (UI). |
There was a problem hiding this comment.
That's a great rewrite that adds the why. My suggestion to cut things out is for these reasons:
-
"in certain situations, such as" gives a nice flow, yet it can be removed without loosing a lot of meaning: "You might want to delete a cluster if it fails to..." That would create an even more concise doc.
-
There's kinda an unspoken rule that in docs we focus on normal operation of products and avoid mentioning less typical outcomes like faulty behaviour and failure scenarios. We kinda “reserve negativity” for special cases docs where mentioning bugs and disaster events is unavoidable like in troubleshooting guides. This assembly can remain helpful without reminding users that our products can fail. If that makes sense. I'm open to discuss that further here or in Slack.
-
Phrasal verbs are frowned upon, and set up can be replaced with create. On the other hand, set up is very common in tech docs and won't confuse anyone, we could as well keep it.
| You might want to delete your {product-title} cluster in certain situations, such as if it fails to install properly, encounters errors during provisioning, or if it was set up for testing purposes only. You can delete your cluster using either the {rosa-cli-first} or the user interface (UI). | |
| You might want to delete your {product-title} cluster if you created it for testing purposes only or no longer need it for other reasons. You can delete your cluster using either the {rosa-cli-first} or the user interface (UI). |
Version(s):
4.20+
Issue:
https://redhat.atlassian.net/browse/OSDOCS-16812
Link to docs preview:
Deleting your cluster
Peer review:
QE review:
Additional information: