elektra icon indicating copy to clipboard operation
elektra copied to clipboard

DNS zone UI: incorrect error messages

Open corey-aloia opened this issue 1 year ago • 2 comments

  • in the UI as well as the documentation, there is this incorrectly worded error message "Domain test is not end with a dot". It should likely be "Domain test does not end with a dot": image
  • TTL is not designated as required with a * although it is required.
  • When not using the appropriate top level domain, the error message is API: More than one label is required This probably makes no sense to many users image
  • If the top-level domain is invalid, then the error message API: invalid TLD. The user does not have an input called TLD, so IMO this could be a bit confusing: image

Maybe just another thought: why have the prefix API: in the error message? Sometimes it is API: provided object is not valid. Does this help an end user? I would expect from a UI that there is a mapping of input box - to error message. For example, if the "name" is incorrect, then I would either expect to see this in the error message, or have the input box itself turn red. This brings up the idea of calling the dns zone tld as "name". Potentially this should just be "TLD" as name to me indicates that it has no bearing on functionality, but is just a name.

corey-aloia avatar Sep 13 '23 07:09 corey-aloia

So the problem here is that all those error messages that are prefixed with Api: are error messages that are returned by the API, so Designate in this case. In those cases we typically don't have the context information that would allow us to e.g. mark the input of the value that produced the error as you suggest. All we get is the error String.

I like your suggestion to change the label from just Name to maybe something like Name (TLD), as that would help with some of the error messages. Also if TTL is indeed mandatory, I agree that we should change this.

edda avatar Sep 14 '23 11:09 edda

Maybe it would be a good idea to collect the most common error messages and their causes and add this information to the user documentation.

edda avatar Sep 14 '23 11:09 edda