-
Notifications
You must be signed in to change notification settings - Fork 86
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
Improve the messages for notation verify
#620
Comments
Move to post v1 release, as it is not critical for v1 release cc @vaninrao10 |
Moved this issue to v1.2.0 milestone and linking #834 as we are improving all error messages in v1.2.0. |
Move the status message to the first line sounds reasonable because in general users care about the operation result at the first. Warning message is a follow-up reminder that users should be paying attention to. For the operation status, I think it is not necessary to show How about improve the success and error messages as follows?
|
Warning messages may be generated dynamically during the verification process. Any delay in displaying these warning messages will prevent users from knowing the current status of the verification. Are there any well-known CLIs that also delay showing warnings, so we can follow best practices? |
What is the areas you experience the issue in?
Notation CLI
What is not working as expected?
The following two output messages from
notation verify
look very similar although one is successful and the other is error:What did you expect to happen?
We should rework those to make it obvious what is the result of the command. Right now they both start with the
warning
and this is the first thing the user sees. The user is more interested in the result of the command than thewarning
. An example can be:and
Adding white space and moving the
warning
to secondary provides better usability. Also, the current messages are not consistent in the language and not capitalized and grammatically correct.How can we reproduce it?
Use the commands above
Describe your environment
N/A
What is the version of your Notation CLI or Notation Library?
Notation: Notary v2, A tool to sign, store, and verify artifacts.
Version: 1.0.0-rc.3
Go version: go1.20.1
Git commit: 233c0ea
The text was updated successfully, but these errors were encountered: