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

Make Lighthouse error string more user friendly #3598

Closed
vinamratasingal-zz opened this issue Oct 17, 2017 · 4 comments · Fixed by #4280
Closed

Make Lighthouse error string more user friendly #3598

vinamratasingal-zz opened this issue Oct 17, 2017 · 4 comments · Fixed by #4280

Comments

@vinamratasingal-zz
Copy link

Lighthouse error strings are not very user friendly, especially for the timeout cases. Can we make it such that the error strings don't just dump out the debug string but tell users what they can do (if timeout, then tell them to try using the CLI and increase timeout, or if it's a tracing failure, then ask them to just rerun the trace).

@vinamratasingal-zz
Copy link
Author

@paulirish
Copy link
Member

Looking at these, I'm thinking we might want to use a lot more space to appropriately explain each error. One slight modification is that we give each error an error code and then link up some docs.

For example, in Alice's old a11y extension, she'd link to https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_02 for the explanation. Giving each error a code that's googleable is also the approach chrome security takes for all the various certificate/tls issues.

So perhaps:

Something went wrong with recording the trace during your page load (No domContentLoaded event found). Please try again. (Error code: NO_DCL_EVENT_FOUND)

In the docs link we could expand a bit and link to various github issues or resolution recommendations.

@paulirish
Copy link
Member

paulirish commented Jan 8, 2018

AFAIK, patrick, v and I are all happy with the strings in there now.

  • Strings and error codes are defined
  • docs page for the various error codes. we will defer this for now?
  • Land these string changes in LH. Optionally introduce the strings.js file for maintenance.

@paulirish
Copy link
Member

over to @patrickhulce for the 3rd checkbox above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants