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

Feature: use relative paths instead of absolute paths in error messages #59

Closed
sallain opened this issue Oct 3, 2024 · 4 comments
Closed

Comments

@sallain
Copy link
Contributor

sallain commented Oct 3, 2024

Is your feature request related to a problem? Please describe.

When a user reviews an error message for a validation activity that failed, they are shown the absolute path of the problematic file or directory. The absolute path is long and much of it is meaningless to the average user; in talk-aloud testing, we found that they skipped right over it and were unable to identify which file or directory was causing the issue.

image

The absolute path is used in error messages in the following activities:

  • Validate SIP structure
  • Validate SIP file formats

On a related, but inverse, note, Verify SIP manifest seems to be already using relative paths, though actually it might be TOO short. For the sake of consistency, all paths should start at the top-level SIP directory.

image

Describe the solution you'd like

Using the relative path of the file, starting at the top-level directory of the SIP, should make the path more comprehensible to users.

Describe alternatives you've considered

Can't really think of any - we need to provide enough information that the file/directory is uniquely identifiable, but not too much. Hopefully this is the right balance.

Additional context

This is a child issue of #43

@sallain
Copy link
Contributor Author

sallain commented Oct 30, 2024

LGTM!

@sallain sallain closed this as completed Oct 30, 2024
@github-project-automation github-project-automation bot moved this from 🧐 QA to 🎉 Done in Enduro Oct 30, 2024
@sallain
Copy link
Contributor Author

sallain commented Nov 1, 2024

Whoops, I just noticed that the absolute path is also used in Validate SIP metadata:
Image

@sallain sallain reopened this Nov 1, 2024
@fiver-watson
Copy link

@DanielCosme @sallain I see that feedback was added to this, but i am not sure it was noticed, so I am leaving this comment and moving this card back to in progress, so that the additional absolute paths found during QA above can be addressed at some point.

@fiver-watson
Copy link

That error is now showing a relative path - thanks!

@github-project-automation github-project-automation bot moved this from 🧐 QA to 🎉 Done in Enduro Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

No branches or pull requests

3 participants