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

Fix version warning banner on the stable documentation page #29075

Closed
betatim opened this issue May 22, 2024 · 6 comments
Closed

Fix version warning banner on the stable documentation page #29075

betatim opened this issue May 22, 2024 · 6 comments

Comments

@betatim
Copy link
Member

betatim commented May 22, 2024

Describe the issue linked to the documentation

Currently https://scikit-learn.org/stable/index.html shows the version warning banner ("This are the docs for an unstable version").
Screenshot 2024-05-22 at 09 08 02

I think this is happening because we haven't updated https://scikit-learn.org/dev/_static/versions.json which lists all the available versions and declares which is the stable version.

This file is generated by build_tools/circle/list_versions.py which should run as part of the CI on main. My guess as to why the file hasn't been updated is that we have not merged a PR since releasing v1.5.0. If I run the script locally it generates the correct content for the .json file.

Suggest a potential alternative/fix

I think the fix is to merge any PR into main as this will regenerate the versions.json file.

This is because all versions of the documentation read the versions from the same URL, which is based on /dev/.

@betatim betatim added Documentation Needs Triage Issue requires triage and removed Needs Triage Issue requires triage labels May 22, 2024
@betatim
Copy link
Member Author

betatim commented May 22, 2024

Let's see if merging #29071 fixed this

@betatim
Copy link
Member Author

betatim commented May 22, 2024

Looks like this is now fixed 🎉

@betatim betatim closed this as completed May 22, 2024
@betatim
Copy link
Member Author

betatim commented May 22, 2024

For the next release we need to figure out how we perform the update of versions.json without having to merge a "random" PR.

@lesteve
Copy link
Member

lesteve commented May 22, 2024

This seems fixed indeed, thanks for noticing and opening an issue!

@adrinjalali
Copy link
Member

cc @Charlie-XIAO

@Charlie-XIAO
Copy link
Contributor

For the next release we need to figure out how we perform the update of versions.json without having to merge a "random" PR.

What about #29077 instead of a "random" PR? If I'm not mistaken updating SECURITY.md is the last step of a release process and should be done except for RC. Such a PR should also be quick to review and merge.

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

No branches or pull requests

4 participants