Skip to content

DOC: What release version do we want in the header? #32748

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

Closed
TomAugspurger opened this issue Mar 16, 2020 · 7 comments · Fixed by #32870
Closed

DOC: What release version do we want in the header? #32748

TomAugspurger opened this issue Mar 16, 2020 · 7 comments · Fixed by #32870
Labels
Milestone

Comments

@TomAugspurger
Copy link
Contributor

I think this has come up before, but which whatsnew document, if any, do we want to link from the header? The "What's New in 1.0.1" in the screenshot below.

Screen Shot 2020-03-16 at 8 16 42 AM

Choices

  1. Latest release (e.g. 1.0.2)
  2. Last major release (e.g. 1.0.0)
  3. None

cc @jorisvandenbossche @datapythonista.

(I think my preference is for option 3, since it's not clear whether 1 or 2 is better, so put it behind an extra click via the "Release Notes" page).

@datapythonista
Copy link
Member

As a user, I think what I'd be interested at this point (1.0.3 being the latest), is the changelog for 1.0.0 + 1.0.1 + 1.0.2 + 1.0.3. I feel if I'm visiting this page, I'm more likely to be in the previous minor (e.g. I'm moving from 1.2 to 1.3).

But that's not what I'm proposing. May be we could consider a hierarchy of changelogs now that we're using the major, but don't really know if it's a good idea or not.

For now I'd also say 3, just call that section Release notes, and let the user decide.

@simonjayhawkins
Copy link
Member

For now I'd also say 3, just call that section Release notes, and let the user decide.

Release notes is already in the header, so just remove "What's New in ..." link ?

@TomAugspurger
Copy link
Contributor Author

Yeah, that's my option 3. You'd go to https://pandas.pydata.org/docs/whatsnew/index.html, and from there navigate to most recent, the last bugfix release (https://pandas.pydata.org/docs/whatsnew/v1.0.3.html) or perhaps "most relevant", the last major or minor release (https://pandas.pydata.org/docs/whatsnew/v1.0.0.html)

@WillAyd
Copy link
Member

WillAyd commented Mar 19, 2020

+1 to option 3 as well

@Dr-Irv
Copy link
Contributor

Dr-Irv commented Mar 20, 2020

I was about to report this issue, and found this discussion, and agree that you should remove the "What's New" link. But maybe change "Release Notes" to "Release Notes/What's New" ?

@jorisvandenbossche
Copy link
Member

jorisvandenbossche commented Mar 20, 2020

I agree to remove the "What's new in x.x.x" as well

But maybe change "Release Notes" to "Release Notes/What's New" ?

I think that will become a bit long (especially for a top bar), so personally would choose one of both.
"What's new?" would also be fine for me

@jorisvandenbossche
Copy link
Member

We could also have a more visible link on the doc home page to the "latest" (1.0.0, or 1.0.3, or a combined view) whatsnew page, if we remove it from the top bar.
(although those links are already there on the website)

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

Successfully merging a pull request may close this issue.

6 participants