OSDOCS-17077: Web console update CQA#108054
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@skopacz1: This pull request references OSDOCS-17077 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 story to target the "4.22.0" version, but no target version was set. DetailsIn response to this:
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. |
openshift-ci
Bot
added
the
size/L
There was a problem hiding this comment.
This is entirely new content I added after realizing this page doesn't actually tell users to unpause their machine health checks, and requires full SME/QE review
| . Review the notification detailing the potential risks to updating. | ||
|
|
||
|
|
||
| // Should this module be its own thing? No newline at end of file |
There was a problem hiding this comment.
This is an entire module just to show users one checkbox they can optionally select while choosing an update version, without much additional context on what they are looking at. Also, it comes after the procedure to actually perform an update.
IMO this could be an optional step in the main update procedure, and if we want we can add a link to somewhere that talks more about conditional updates. WDYT?
| //link that follows is in the assembly: updating-cluster-between-minor | ||
| If you want to use the canary rollout update process, see "Performing a canary rollout update". | ||
|
|
||
| // Should this module exist when there's a page dedicated to canary rollout? No newline at end of file |
There was a problem hiding this comment.
I don't know why this module exists when there is a canary rollout update page with 90% of the content mentioned in this section, plus actual instructions for implementing the update.
I feel like at most, the web console page should make a one-paragraph mention about canary rollouts, and then point users to the right doc. This might be too much context for something unrelated to generic web console updates.
|
🤖 Fri Mar 20 15:02:43 - Prow CI generated the docs preview: |
openshift-ci
Bot
added
size/M
| [IMPORTANT] | ||
| ==== | ||
| * When an update is failing to complete, the Cluster Version Operator (CVO) reports the status of any blocking components while attempting to reconcile the update. Rolling your cluster back to a previous version is not supported. If your update is failing to complete, contact Red{nbsp}Hat support. | ||
| * Using the `unsupportedConfigOverrides` section to modify the configuration of an Operator is unsupported and might block cluster updates. You must remove this setting before you can update your cluster. | ||
| ==== No newline at end of file |
There was a problem hiding this comment.
This is moved in here from the assembly, not new content
skopacz1
force-pushed
the
OSDOCS-17077_2
branch
from
4ff4598 to
9b96373
Compare
|
@skopacz1: This pull request references OSDOCS-17077 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 story to target the "4.22.0" version, but no target version was set. DetailsIn response to this:
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. |
skopacz1
added
the
merge-review-needed
dfitzmau
added
merge-review-in-progress
|
|
||
| Before updating, consider the following: | ||
| [role="_abstract"] | ||
| Before updating your cluster, consider the following information: |
There was a problem hiding this comment.
Abstract should not be a lead-in sentence based on SEO results.
There was a problem hiding this comment.
The short description should state the what and why.
There was a problem hiding this comment.
Good catch, it was hard to write anything additional about this section but I will make an honest effort to add something that's not self referential
| .Additional resources | ||
|
|
||
| * xref:../../architecture/control-plane.adoc#about-machine-config-operator_control-plane[About the Machine Config Operator]. No newline at end of file | ||
| * xref:../../architecture/control-plane.adoc#about-machine-config-operator_control-plane[About the Machine Config Operator] No newline at end of file |
There was a problem hiding this comment.
I'm not brought to a section "About the Machine Config Operator"?
There was a problem hiding this comment.
Hmm very true, maybe the location changed over time. Let me update this xref to lead the correct section.
dfitzmau
removed
the
merge-review-in-progress
skopacz1
force-pushed
the
OSDOCS-17077_2
branch
from
9b96373 to
47f8c6c
Compare
|
@skopacz1: 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. |
|
/cherrypick enterprise-4.16 |
|
/cherrypick enterprise-4.17 |
|
/cherrypick enterprise-4.18 |
|
/cherrypick enterprise-4.19 |
|
/cherrypick enterprise-4.20 |
|
@skopacz1: new pull request created: #108782 DetailsIn response to this:
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. |
|
@skopacz1: new pull request created: #108783 DetailsIn response to this:
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. |
|
@skopacz1: new pull request created: #108784 DetailsIn response to this:
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. |
|
@skopacz1: new pull request created: #108785 DetailsIn response to this:
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. |
|
@skopacz1: new pull request created: #108786 DetailsIn response to this:
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. |
|
@skopacz1: new pull request created: #108787 DetailsIn response to this:
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. |
|
@skopacz1: new pull request created: #108788 DetailsIn response to this:
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. |
6 participants
OSDOCS-17077
Version(s): 4.16+
This PR is one of several to perform a CQA of the updating procedures in the OTA docs.
No new content added.
QE review: No technical accuracy changes and therefore no need for QE, but let me know if you think anything needs a review.
Preview: Updating a cluster using the web console