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

DNS zone UI: incorrect error messages #1262

Open
corey-aloia opened this issue Sep 13, 2023 · 2 comments
Open

DNS zone UI: incorrect error messages #1262

corey-aloia opened this issue Sep 13, 2023 · 2 comments
Assignees
Labels
enhancement neverstale will be ignored by close-stale-issues workflow

Comments

@corey-aloia
Copy link

corey-aloia commented Sep 13, 2023

  • 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 corey-aloia changed the title DNS zone UI: incorrect error messages in the UI DNS zone UI: incorrect error messages Sep 13, 2023
@edda
Copy link
Collaborator

edda commented Sep 14, 2023

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
Copy link
Collaborator

edda commented Sep 14, 2023

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.

@hgw77 hgw77 self-assigned this Apr 8, 2024
@github-actions github-actions bot added the Stale label Sep 4, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 11, 2024
@edda edda reopened this Sep 12, 2024
@edda edda added neverstale will be ignored by close-stale-issues workflow and removed Stale labels Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement neverstale will be ignored by close-stale-issues workflow
Projects
None yet
Development

No branches or pull requests

3 participants