Readthedocs.org: Improve unexpected error message

Created on 12 Oct 2018  路  7Comments  路  Source: readthedocs/readthedocs.org

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.

Improvement

Most helpful comment

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)."

All 7 comments

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)."

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

"try again _later_.", maybe is better.

The rest is perfect to me.

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

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

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

@humitos I think your past self already filled this issue :D https://github.com/rtfd/readthedocs.org/issues/4010

@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.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

gtalarico picture gtalarico  路  4Comments

SylvainCorlay picture SylvainCorlay  路  3Comments

lennartkoopmann picture lennartkoopmann  路  4Comments

humitos picture humitos  路  4Comments

PowerKiKi picture PowerKiKi  路  4Comments