Skip to content

Improve unexpected error message #4751

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

Closed
humitos opened this issue Oct 12, 2018 · 7 comments
Closed

Improve unexpected error message #4751

humitos opened this issue Oct 12, 2018 · 7 comments
Labels
Improvement Minor improvement to code

Comments

@humitos
Copy link
Member

humitos commented Oct 12, 2018

Many users are reporting / filling an issue in our issue tracker when this message is shown to them, which is logic because it's what the message says.

There was a problem with Read the Docs while building your documentation. Please report this to us with your build id (1234)

Although, I think we should improve this message saying something like "if this problem persists, please report..." or something similar to that. Otherwise, sometimes it's a temporal failure and we get tons of reports.

@humitos humitos added the Improvement Minor improvement to code label Oct 12, 2018
@humitos humitos added this to the Build error reporting milestone Oct 12, 2018
@dojutsu-user
Copy link
Member

dojutsu-user commented Oct 12, 2018

I would like to take this issue.
My suggestion for the error message is this -
"There was a problem with Read The Docs while building your documentation. This might be a temporary error. We suggest you to try again. However, if this problem persists, please report to us with your build id (1234)."

@humitos
Copy link
Member Author

humitos commented Oct 12, 2018

This might be a temporary error. We suggest you to try again

"try again later.", maybe is better.

The rest is perfect to me.

@dojutsu-user
Copy link
Member

dojutsu-user commented Oct 13, 2018

@humitos I found this error message in files located at readthedocs/locale/ and logs/debug.log, should i change this line there too?

@humitos
Copy link
Member Author

humitos commented Oct 15, 2018

@dojutsu-user no. Those files do not require modifications for this.

@dojutsu-user
Copy link
Member

@humitos okay, I have made the PR, please review it.

@stsewd
Copy link
Member

stsewd commented Oct 25, 2018

@humitos I think your past self already filled this issue :D #4010

@humitos
Copy link
Member Author

humitos commented Oct 27, 2018

@humitos I think your past self already filled this issue :D #4010

I really hate how GitHub search issues/prs work. I never find what I'm looking for.

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

No branches or pull requests

3 participants