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 link to docs in error message #10910

Merged
merged 2 commits into from
Nov 27, 2023
Merged

Add link to docs in error message #10910

merged 2 commits into from
Nov 27, 2023

Conversation

hugovk
Copy link
Contributor

@hugovk hugovk commented Nov 19, 2023

When a build fails due to a missing config file, it's not always clear what action should be taken. For example:

python/pythondotorg#2327 (comment)

I suggest including a link to a webpage that explains what action is needed. Perhaps this blog post?

https://blog.readthedocs.com/migrate-configuration-v2/

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion!

readthedocs/config/config.py Outdated Show resolved Hide resolved
Co-authored-by: Manuel Kaufmann <[email protected]>
@hugovk hugovk changed the title Add link to blog in error message Add link to docs in error message Nov 22, 2023
@humitos humitos merged commit 60944ee into readthedocs:main Nov 27, 2023
2 checks passed
@hugovk hugovk deleted the patch-1 branch November 27, 2023 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants