docs: Remove release notes and fully capture them in GitHub Releases #3380
Conversation
…e everything from changes.rst. Added missing versions in GitHub Releases page so that all information is captured there.
|
@jonmmease https://github.com/altair-viz/altair/actions/runs/8402900588/job/23012797705?pr=3380 fails due to some different outputs from VegaFusion. It's unrelated to this PR as I'm only modifying the docs here. Maybe something to do with the latest VF release? Would you mind taking a look? Otherwise, I can look into it later this week. |
|
Yes, it's from a change in the latest VegaFusion release. I fixed the tests in #3377, which I think is ready to merge as soon as someone has time to look over it. |
doc/releases/changes.rst
Outdated
| -------------------------- | ||
| - Update Vega-Lite from version 5.16.3 to version 5.17.0; | ||
| see `Vega-Lite Release Notes <https://github.com/vega/vega-lite/releases>`_. | ||
| We have moved the release notes to GitHub. You'll be automatically redirected there in 3 seconds, or you can click `here <https://github.com/altair-viz/altair/releases>`_. |
There was a problem hiding this comment.
Is there an urgent need to redirect automatically?
There was a problem hiding this comment.
No urgent need. I thought redirecting in general is good to not lose users. An additional click is always an opportunity for someone to drop out. And 3 seconds felt like enough time for me to read the message but no strong preference on how we handle this. What do you think?
There was a problem hiding this comment.
Just stumbled on pandas doing the same with around 1 second of wait time: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.to_json.html
There was a problem hiding this comment.
Double negative alert: I thought not to auto redirect in order to not lose users..
At least we have the same intention😀!
There was a problem hiding this comment.
I don't notice a redirect on the pandas website, it stays within the pandas documentation page isn't it?
There was a problem hiding this comment.
Ah I think I see what you mean! Same intentions but I think not redirecting might indeed be a better way to achieve this. I'll remove the automated redirect so users can decide themselves if they want to go to GitHub or stay in the Altair docs.
Re the Pandas docs: Maybe they changed that... Yesterday it showed briefly a message before redirecting. Now it directly goes to stable/reference instead of stable/generated. Anyway :)
Closes #3339. I added the missing releases to GitHub Releases and made sure that all content from the docs is captured in there.
"Release Notes" in the navigation bar now links directly to GitHub:
And the old /releases/changes.html URL redirects to GitHub after showing a message that the content got moved:
I moved the draft release notes for 5.3.0 into
RELEASING.mdso we don't loose them. I'll remove them when I'll do the 5.3 release. To capture release notes in the future, see Joel's suggestion here