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

Please add words that describe the event types in the dashboard #3182

Closed
4 tasks done
wez opened this issue Jan 12, 2024 · 6 comments · Fixed by #3898
Closed
4 tasks done

Please add words that describe the event types in the dashboard #3182

wez opened this issue Jan 12, 2024 · 6 comments · Fixed by #3898
Labels
enhancement improve existing features ui frontend related

Comments

@wez
Copy link
Contributor

wez commented Jan 12, 2024

Clear and concise description of the problem

I had a difficult time understanding this failure; there's no written out words to indicate the event type and the icons are not intuitive enough to understand.

image

It turned out that this was neither a pr nor a push event, and the secrets were not allowed to be used with it.
Drilling into the event also showed no additional useful context beyond just the raw error condition:

image

Suggested solution

Please add some words in there somewhere!
For example, it would be really useful to see something like event: deployment or whatever this actual event was in the drilled down state.

Please add tooltips to the icons to label the event type, so that hovering over it will spell out to the user what it is.

Alternative

No response

Additional context

No response

Validations

  • Checked that the feature isn't part of the next version already [https://woodpecker-ci.org/faq#which-version-of-woodpecker-should-i-use]
  • Read the Contributing Guidelines.
  • Read the docs.
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
@wez wez added the feature add new functionality label Jan 12, 2024
@zc-devs
Copy link
Contributor

zc-devs commented Jan 12, 2024

Screenshot 2024-01-13

  1. This icons point to the type of event a little bit.
  2. One of solutions can be just tooltip with a text, that describes the icons.

@qwerty287 qwerty287 added ui frontend related enhancement improve existing features and removed feature add new functionality labels Jan 13, 2024
@qwerty287
Copy link
Contributor

Adding tooltips is a good idea, but anything else I wouldn't do.

@anbraten
Copy link
Member

I am already updating the part 😉

@anbraten
Copy link
Member

anbraten commented Jan 13, 2024

I am also thinking about some general improvements to the list. Just tried to get some inspiration from v0: https://v0.dev/r/ezhlRyoM0sq 😅

What do you think about removing the commit sha from the list.
For PR I am also missing the commit message in addition to the PR title atm.

@wez
Copy link
Contributor Author

wez commented Jan 13, 2024

FWIW, when there is an error having as much context available as possible makes things easier to diagnose and understand. I appreciate having things be compact and beautiful in the (hopefully common!) passing case, but when things are broken, if it is not possible to understand why, then the software is less useful.

Most users of CI are not experts in the CI system itself, so expecting them to have instant recall and understanding of the features of the CI system is a big expectation, representing a massive learning curve.
When a pipeline starts failing due to a CI configuration issue (as in this case), they switch from trying to understand errors in what they just changed to trying to understand software that they rarely need to go deep with, and they have little-to-no intuition about its errors or diagnostics.

What do you think about removing the commit sha from the list.

Please don't thin down the information shown for these status lines. In fact, I would love it if there was a way to drill down into seeing more information.

Adding tooltips is a good idea, but anything else I wouldn't do.

Having words that can be copied and pasted is really useful. Having more context in the error message would also be incredibly valuable.

eg: Secret XXX not found or not allowed to be used in YYY event.

The YYY could then either be enabled by the user if appropriate, or, as was in my case, I added a condition to prevent this step from executing in the YYY case. If I had an actual word (YYY) to copy and paste, I could then potentially search for it in the docs, or the code, and then paste it into the condition I ended up writing for the pipeline.

So while my immediate concern would be helped with a tooltip, I would appreciate it if you all could consider making the diagnostics and data available in the UI quicker and easier for someone to act upon.

@zc-devs
Copy link
Contributor

zc-devs commented Jan 13, 2024

What do you think about removing the commit sha from the list

I'm against this. Now, from commit I can say, that 82 and 81 are the same commit, 84 was force push of 83, 85 is just tagged 84.

For PR I am also missing the commit message in addition to the PR title atm.

In that case, we can probably move down commit message a bit and add PR header above:
pr-header

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement improve existing features ui frontend related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants