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

Add clickable docs links to error messages #3456

Closed
1 task done
lilaconlee opened this issue Feb 13, 2019 · 7 comments · Fixed by #3457
Closed
1 task done

Add clickable docs links to error messages #3456

lilaconlee opened this issue Feb 13, 2019 · 7 comments · Fixed by #3457
Assignees
Labels
type: user experience Improvements needed for UX

Comments

@lilaconlee
Copy link
Contributor

lilaconlee commented Feb 13, 2019

Current behavior:

Does not support markdown

Desired behavior:

Should support markdown for links to docs.

Originally this issue was to add full Markdown support, but that'll require a bit more work at a later date. This PR will just add links and the scaffolding to more easily add markdown support later on.

  • Add Markdown rendering that only linkifys on.cypress.io domains
@jennifer-shehane
Copy link
Member

Relevant issues:

@lilaconlee
Copy link
Contributor Author

Ok, updated a handful of errors to get a sense of the different content in the messages. I'd love to get feedback before updating any more messages.

Changes:

  • Docs links are clickable (based on https://on.cypress.io in the text)
  • Backticks added for command names, file paths, error messages (stripped in run mode)
  • Blockquotes are indented (given we'd like to add code framing, didn't want to spend too much time updating these but think it'd be good to eventually add some sort of code snippet formatting)

Examples

screen shot 2019-02-19 at 2 42 17 pm

screen shot 2019-02-19 at 2 37 19 pm

screen shot 2019-02-19 at 2 27 19 pm

screen shot 2019-02-19 at 2 22 55 pm

Before/after screenshots of all the errors I've updated in interactive and run mode can be found here.

@jennifer-shehane
Copy link
Member

The inline links makes this whole thing work it. 💖

@lilaconlee
Copy link
Contributor Author

Talked with Brian about error improvement yesterday, going to update error messages in a way where we focus on making changes to the most valuable error messages. Getting full markdown support done in a good looking way will take a bit more work, but figured we could just get clickable docs links in given it was already done.

@lilaconlee lilaconlee changed the title Add markdown support for test runner error messages Add clickable docs links to error messages Feb 22, 2019
@lilaconlee lilaconlee added stage: needs review The PR code is done & tested, needs review and removed stage: work in progress labels Feb 22, 2019
@cypress-bot cypress-bot bot added stage: work in progress and removed stage: needs review The PR code is done & tested, needs review labels Feb 22, 2019
@jennifer-shehane
Copy link
Member

I wonder if this issue about adding doc links to command log should be part of the work here: #3610

@cypress-bot cypress-bot bot added stage: needs review The PR code is done & tested, needs review stage: work in progress and removed stage: work in progress stage: needs review The PR code is done & tested, needs review labels Mar 21, 2019
@cypress-bot
Copy link
Contributor

cypress-bot bot commented Mar 21, 2019

The code for this is done in cypress-io/cypress#3457, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

@cypress-bot
Copy link
Contributor

cypress-bot bot commented May 17, 2019

Released in 3.3.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: user experience Improvements needed for UX
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants