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

"This may be an old version of this documentation" warning #402

Closed
rouault opened this issue Oct 11, 2024 · 5 comments
Closed

"This may be an old version of this documentation" warning #402

rouault opened this issue Oct 11, 2024 · 5 comments

Comments

@rouault
Copy link

rouault commented Oct 11, 2024

Hello,

we use ReadTheDocs infrastructure for https://github.com/OSGeo/PROJ documentation.
Currently we redirect https://proj.org to the latest maintenance branch at https://proj.org/en/9.5/ rather than using the https://proj.org/en/stable tag. We currently get a "This may be an old version of this documentation" warning which is confusing for users, as this is actually the most up to date version of the doc (excepting unreleased "latest" = master). Is there a way to suppress this warning?

@humitos
Copy link
Member

humitos commented Oct 11, 2024

Is there a way to suppress this warning?

Yes. You can go to the settings of your project using the new dashboard at https://app.readthedocs.org/. Then going to "Addons -> Notification" and disabling it from there.

@humitos humitos closed this as completed Oct 11, 2024
@rouault
Copy link
Author

rouault commented Oct 11, 2024

Then going to "Addons -> Notification" and disabling it from there.

Ideally I would have liked to be able to tag "9.5" as non-outdated, but "9.4", "9.3" and older as outdated. But disabling all notification is acceptable for now. Thanks for the hint

@humitos
Copy link
Member

humitos commented Oct 12, 2024

Yeah, I understand. Defining the outdated version is hard to do it in a generic way that works for all the projects. That's why we decided to only work over "stable" and "latest" versions for now. We plan to give users more control on what versions are the outdated one in the future.

@kbevers
Copy link

kbevers commented Oct 14, 2024

Defining the outdated version is hard to do it in a generic way that works for all the projects.

I think you've done a good job of that by assuming that anything other than latest and stable is outdated. If the "default version" could be thrown in the mix as a version that's also not outdated we'd be happy. The assumption here of course being that if a project sets a version as the default it's not likely to be outdated.

@humitos
Copy link
Member

humitos commented Oct 14, 2024

I think you've done a good job of that by assuming that anything other than latest and stable is outdated. If the "default version" could be thrown in the mix as a version that's also not outdated we'd be happy.

I thought we were doing this already. Maybe there is a bug. I'll check the code to confirm.

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

No branches or pull requests

3 participants