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

Notification: "default version" shouldn't show "This may be an outdated version" #406

Closed
humitos opened this issue Oct 14, 2024 · 7 comments · Fixed by #407
Closed

Notification: "default version" shouldn't show "This may be an outdated version" #406

humitos opened this issue Oct 14, 2024 · 7 comments · Fixed by #407
Assignees

Comments

@humitos
Copy link
Member

humitos commented Oct 14, 2024

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.

(posted by @ kbevers in #402 (comment))


I'm opening this issue to research about this a little more.

@kbevers do you have an example where you getting the unexpected behavior? That would be pretty useful to me to understand what's going on here.

@humitos humitos added the Needed: more information A reply from issue author is required label Oct 14, 2024
@kbevers
Copy link

kbevers commented Oct 14, 2024

Sure. The example is the PROJ project mentioned in #402. We've turn of the warning as recommended so at the moment it doesn't show. But from the settings panel you can see that we've got the 9.5 branch as the default version:

billede

I basically just found it odd that the default version would result in a warning.

humitos added a commit that referenced this issue Oct 14, 2024
Don't show the notification "This may be an old version of this documentation"
if the reader is currently reading the `Project.default_version`.

I'm on the fence about doing this part of the default logic or a config on its
own. I'll probably change it to a config after thinking a little more, but
pushing these changes for now.

Closes #406
@humitos
Copy link
Member Author

humitos commented Oct 14, 2024

I opened a POC in #407.

I'm still on the fence about adding this logic to the default algorithm or making it an config in the Addons tab. Would it be better for you to have an explicit checkbox in the Addons -> Notification tab saying "[ ] Skip showing a notification on project's default version"?

@kbevers
Copy link

kbevers commented Oct 14, 2024

Would it be better for you to have an explicit checkbox in the Addons -> Notification tab saying "[ ] Skip showing a notification on project's default version"?

That would work just as well

@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Nov 5, 2024
@humitos humitos self-assigned this Nov 5, 2024
@sersorrel
Copy link

I'm unsure how our docs are configured, but we also see a spurious "This is the latest development version" notification on our docs at https://cellgeni.readthedocs.io/en/latest/index.html, despite there being no stable version (the link 404s).

@humitos
Copy link
Member Author

humitos commented Nov 19, 2024

@sersorrel

despite there being no stable version (the link 404s).

The link works for me and goes to https://cellgeni.readthedocs.io/en/stable/

I'm unsure how our docs are configured, but we also see a spurious "This is the latest development version" notification

You can disable this notification from the dashboard. Check our docs at https://docs.readthedocs.io/en/stable/versions.html#version-warning-notifications

@sersorrel
Copy link

🤦‍♀️ I tried at https://cellgeni.readthedocs.io/en/latest/farmer.html which is brand new and therefore has no stable page, apologies...

Thanks, I clearly need to investigate how we've set this up.

@humitos humitos moved this from Planned to Needs review in 📍Roadmap Nov 20, 2024
@humitos humitos removed the Needed: more information A reply from issue author is required label Nov 20, 2024
@github-project-automation github-project-automation bot moved this from Needs review to Done in 📍Roadmap Nov 21, 2024
@humitos
Copy link
Member Author

humitos commented Nov 26, 2024

We just deployed this. You should not see a notification on the default version now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants