Skip to content
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

Bug 1992680: pkg/cli/admin/upgrade/upgrade: Copy edits, including "assists with cluster upgrades" #899

Merged
merged 1 commit into from Aug 16, 2021

Conversation

wking
Copy link
Member

@wking wking commented Aug 16, 2021

The previous:

This command will request that the cluster begin an upgrade...

and similar confused some readers, because the no-argument invocation is just a read query that does not request an update. This commit makes the wording more generic, to match the subcommand's actual generic functionality (reading from and optionally writing to ClusterVersion).

I've also tweaked the "No updates available" message to avoid folks misreading as:

... doing so may not... result in downtime or data loss.

when we are trying to convey that updating despite a lack of recommendations might be dangerous.

In both cases, the wording I'm altering dates back to the creation of this subcommand in cd30f2f (openshift/origin#21605).

…uster upgrades"

The previous:

  This command will request that the cluster begin an upgrade...

and similar confused some readers [1], because the no-argument
invocation is just a read query that does not request an update.  This
commit makes the wording more generic, to match the subcommand's
actual generic functionality (reading from and optionally writing to
ClusterVersion).

I've also tweaked the "No updates available" message to avoid folks
misreading as:

  ... doing so may not... result in downtime or data loss.

when we are trying to convey that updating despite a lack of
recommendations might be dangerous.

In both cases, the wording I'm altering dates back to the creation of
this subcommand in cd30f2f (Add `oc adm upgrade` to display
available updates or trigger an update, 2018-12-04,
openshift/origin#21605).

[1]: https://bugzilla.redhat.com/show_bug.cgi?id=1992680#c2
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 16, 2021

@wking: This pull request references Bugzilla bug 1992680, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target release (4.9.0) matches configured target release for branch (4.9.0)
  • bug is in the state NEW, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

Requesting review from QA contact:
/cc @zhouying7780

In response to this:

Bug 1992680: pkg/cli/admin/upgrade/upgrade: Copy edits, including "assists with cluster upgrades"

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/test-infra repository.

@openshift-ci openshift-ci bot added bugzilla/severity-low Referenced Bugzilla bug's severity is low for the branch this PR is targeting. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. labels Aug 16, 2021
@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 16, 2021
@wking
Copy link
Member Author

wking commented Aug 16, 2021

CC @bparees, do you find the wording I'm proposing here more clear than what oc adm upgrade --help is using today? Or do you have further tweaks or alternatives you'd like to float?

I'm leaving the main "Upgradeable=False confused me" bit alone for now, while we sort out if/how we can make that more clear. I don't think we need to block the easy, orthogonal improvements on that particular aspect.

@bparees
Copy link
Contributor

bparees commented Aug 16, 2021

it looks good to me, thank you @wking

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Aug 16, 2021
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 16, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bparees, wking

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

1 similar comment
@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@wking
Copy link
Member Author

wking commented Aug 16, 2021

I'm pretty sure events should not repeat pathologically failing on some DeploymentAwaitingCancellation thing is unrelated, if a root approver wants to:

/override ci/prow/e2e-agnostic-cmd

But I also expect we'll eventually sneak in on retests if they're too busy.

@openshift-bot
Copy link
Contributor

/retest-required

Please review the full test history for this PR and help us cut down flakes.

@bparees
Copy link
Contributor

bparees commented Aug 16, 2021

I'm pretty sure events should not repeat pathologically failing on some DeploymentAwaitingCancellation thing is unrelated

yeah that is on my list to chase elsewhere.

/override ci/prow/e2e-agnostic-cmd

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 16, 2021

@bparees: Overrode contexts on behalf of bparees: ci/prow/e2e-agnostic-cmd

In response to this:

I'm pretty sure events should not repeat pathologically failing on some DeploymentAwaitingCancellation thing is unrelated

yeah that is on my list to chase elsewhere.

/override ci/prow/e2e-agnostic-cmd

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/test-infra repository.

@openshift-ci openshift-ci bot merged commit 681248e into openshift:master Aug 16, 2021
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Aug 16, 2021

@wking: All pull requests linked via external trackers have merged:

Bugzilla bug 1992680 has been moved to the MODIFIED state.

In response to this:

Bug 1992680: pkg/cli/admin/upgrade/upgrade: Copy edits, including "assists with cluster upgrades"

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/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. bugzilla/severity-low Referenced Bugzilla bug's severity is low for the branch this PR is targeting. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants