Skip to content

Backport docs updates (conda-forge link, canonical URL) to 1.5.x #30728

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

Merged
merged 3 commits into from
Jan 28, 2025

Conversation

betatim
Copy link
Member

@betatim betatim commented Jan 28, 2025

I followed the first step from https://scikit-learn.org/dev/developers/maintainer.html#reference-steps (create a new branch from main, then rebase from upstream/1.5.x).

I picked two commits. The first one updates the conda-forge install page we link to, the second one adds teh canonical URL to our docs pages. Need to check if we need the conda-forge change/if it makes sense.

xref #30727

Copy link

github-actions bot commented Jan 28, 2025

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: c61bbca. Link to the linter CI: here

@lesteve
Copy link
Member

lesteve commented Jan 28, 2025

So as feared 1.5.X CI is not fully functional:

@betatim
Copy link
Member Author

betatim commented Jan 28, 2025

Do you know how to add just one more commit to this branch?

@betatim
Copy link
Member Author

betatim commented Jan 28, 2025

I used git cherry-pick 90a51c1 to get #30333 which seems to have worked but the commit hash changed :-/

@lesteve
Copy link
Member

lesteve commented Jan 28, 2025

I used git cherry-pick 90a51c1 to get #30333 which seems to have worked but the commit hash changed :-/

I would have done the same, so seems good enough 😉. I think it's expected that the hash changes (maybe because the timestamp of the commit changes or it may even depend on the previous commit not 100% sure). The CircleCI doc build manages to build so I think this should be alright.

@betatim betatim requested a review from jeremiedbb January 28, 2025 13:09
Copy link
Member

@lesteve lesteve left a comment

Choose a reason for hiding this comment

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

I think we can merge this.

  • this is a doc only PR and the rendered doc looks good (I checked a few pages and made sure they had all rel="canonical" and point to the stable doc
  • we can ignore the Azure failures and can merge even if they are red (no required checks in release branches)

@betatim betatim changed the title DOC Point users to pretty conda-forge install page (#30617) Backport docs updates (conda-forge link, canonical URL) to 1.5.x Jan 28, 2025
@betatim betatim marked this pull request as ready for review January 28, 2025 13:28
@betatim
Copy link
Member Author

betatim commented Jan 28, 2025

I pinged Jeremie to see if he has some insight on the cerry-picking. I'd like to avoid making future updates to 1.5.X harder because I did something weird (cherrypick).

@lesteve
Copy link
Member

lesteve commented Jan 28, 2025

I pinged Jeremie to see if he has some insight on the cerry-picking. I'd like to avoid making future updates to 1.5.X harder because I did something weird (cherrypick).

I am reasonably confident this is the "right way" (or at least "one right way") but let's see what he says 😉

@lesteve
Copy link
Member

lesteve commented Jan 28, 2025

Also thinking about it, I am not sure we want to back-port the improvement to the conda-forge install instructions to the 1.5.X branch.

Not that many people go to the old versions doc pages (old means <= 1.5 at the time of writing since latest release is 1.6), and hopefully the rel="canonical" will work and search engines will stop pointing people to old versions doc pages.

@jeremiedbb
Copy link
Member

I pinged Jeremie to see if he has some insight on the cerry-picking. I'd like to avoid making future updates to 1.5.X harder because I did something weird (cherrypick).

I am reasonably confident this is the "right way" (or at least "one right way") but let's see what he says 😉

That's how we proceed usually. It's expected that the hash changes, don't worry :)

@jeremiedbb
Copy link
Member

Also thinking about it, I am not sure we want to back-port the improvement to the conda-forge install instructions to the 1.5.X branch.

Now that it's there it's less effort to keep it. I let you decide :)

@lesteve lesteve merged commit 8bf6049 into scikit-learn:1.5.X Jan 28, 2025
28 of 33 checks passed
@lesteve
Copy link
Member

lesteve commented Jan 28, 2025

OK let's merge this then! Thanks @jeremiedbb for the reassurance 😉

@lesteve
Copy link
Member

lesteve commented Jan 28, 2025

To make sure this gets deployed to 1.5.X branch we want to make sure this build is green 🤞

@lesteve
Copy link
Member

lesteve commented Jan 28, 2025

The build was green and rel="canonical" has reached the 1.5 website: https://scikit-learn.org/1.5/

Now we just have to wait and see whether that actually fixes the root issue, but I am somewhat optimistic 💪

@betatim betatim deleted the canonical-backport-to-v1.5.x branch January 29, 2025 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants