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

Add hover-over text for ambiguous buttons #9541

Open
jsoref opened this issue Sep 7, 2022 · 7 comments
Open

Add hover-over text for ambiguous buttons #9541

jsoref opened this issue Sep 7, 2022 · 7 comments
Assignees
Labels
area/ui solution/suggested A solution to the bug has been suggested. Someone needs to implement it. type/feature Feature request

Comments

@jsoref
Copy link
Member

jsoref commented Sep 7, 2022

Summary

Documentation and UX need to make it clear how retry and resubmit differ.

image

https://argoproj.github.io/argo-workflows/cli/argo_retry/

argo retry
retry zero or more workflows

argo retry [WORKFLOW...] [flags]

https://argoproj.github.io/argo-workflows/cli/argo_resubmit/

argo resubmit
resubmit one or more workflows

argo resubmit [WORKFLOW...] [flags]

Use Cases

Someone trying to understand when to use retry and when to use resubmit


Message from the maintainers:

Love this enhancement proposal? Give it a 👍. We prioritise the proposals with the most 👍.

@jsoref jsoref added the type/feature Feature request label Sep 7, 2022
@terrytangyuan
Copy link
Member

Retry will run the existing failed workflow whereas resubmit will submit a new workflow with the same spec.

@tczhao
Copy link
Member

tczhao commented Sep 8, 2022

Just to a little bit of clarity.
Retry reruns the failed step/task(s) from the existing failed workflow

@jsoref
Copy link
Member Author

jsoref commented Sep 8, 2022

It sounds like retry will only rerun the failed bits (and cascading following bits) whereas resubmit will start from scratch.

A user shouldn't have to file a bug to find out that distinction, it should be clear from the documentation and it should be clear from the UI.

The docs for each item should clearly indicate what the specific thing does and mention the other one and hint at when one would want to use the other instead,

@jsoref
Copy link
Member Author

jsoref commented Sep 8, 2022

Note: I don't generally advocate GitHub UI elements (I file way more bugs about GitHub than I do about Argo*), but it's worth considering this similar GitHub element:
image

It's easy to understand that there are two similar actions, and it's easy to understand that one is clearly a subset of the other and roughly how it's a subset.

Clicking that first option yields:
image
The extra sentence clarifies what extra (non-failing) items could be run.

@terrytangyuan terrytangyuan changed the title Please clarify the distinction between retry and resubmit Add hover-over text for ambiguous buttons Apr 4, 2023
@agilgur5 agilgur5 self-assigned this Aug 16, 2023
@agilgur5
Copy link
Member

agilgur5 commented Aug 16, 2023

Was looking to add this myself and then found this issue again. Gonna work on this in tandem with docs and help text changes for #11511

Would also like to add tooltips for Terminate vs. Stop as well. Terminate vs. Stop and Retry vs. Resubmit are perhaps the most frequently asked questions I've seen (and personally asked/searched for too).

For anyone finding themselves here:
retry vs. resubmit
terminate vs. stop

@agilgur5
Copy link
Member

One small complication here, these buttons are rendered via the ActionMenu component (tracing: getItems has the items, which use the WorkflowOperationsMap), which is actually in argo-ui and does not have a prop for tooltips. So will need to add tooltips in argo-ui, then update and add the tooltip contents here.

@agilgur5
Copy link
Member

Also for the CLI and its docs, I wrote up #11625 to describe retry vs. resubmit in more details

@agilgur5 agilgur5 added the solution/suggested A solution to the bug has been suggested. Someone needs to implement it. label Jan 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ui solution/suggested A solution to the bug has been suggested. Someone needs to implement it. type/feature Feature request
Projects
Status: No status
Development

No branches or pull requests

4 participants