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

DOC Adds release highlights to front page #17071

Merged

Conversation

thomasjpfan
Copy link
Member

@thomasjpfan thomasjpfan commented Apr 28, 2020

Places release highlights button onto the front page.

This is setup to find the latest highlights in the examples directory.

@thomasjpfan thomasjpfan added this to the 0.23 milestone Apr 28, 2020
@thomasjpfan
Copy link
Member Author

CC @NicolasHug

@NicolasHug
Copy link
Member

Thanks

I feel like we should remove the button to the what's new then. The what's new is still accessible from the bottom of the page, or it's one click away once you're on the highlights page

NicolasHug
NicolasHug previously approved these changes Apr 29, 2020
Copy link
Member

@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

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

Thanks @thomasjpfan

@@ -8,7 +8,7 @@
<h1 class="sk-landing-header text-white text-monospace">scikit-learn</h1>
<h4 class="sk-landing-subheader text-white font-italic mb-3">Machine Learning in Python</h4>
<a class="btn sk-landing-btn mb-1" href="{{ pathto('getting_started') }}" role="button">Getting Started</a>
<a class="btn sk-landing-btn mb-1" href="whats_new/v{{ version }}.html" role="button">What's New in {{ release }}</a>
<a class="btn sk-landing-btn mb-1" href="{{ pathto(release_highlights) }}" role="button">Release Highlights for {{ release_highlights_version }}</a>
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we can directly parse the {{version}} in jinja and hardcode

https://scikit-learn.org/stable/auto_examples/release_highlights/plot_release_highlightsTHE_PARSED_VERSION_HERE.html ?

That would avoid using the html_context and stuff. Just wondering

Copy link
Member Author

@thomasjpfan thomasjpfan Apr 29, 2020

Choose a reason for hiding this comment

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

I wanted to do that, but we have to make sure that the highlights exist for that version. Which means we have to create a placeholder for the highlights when we are working on the next version.

@NicolasHug
Copy link
Member

@rth @adrinjalali @glemaitre @jeremiedbb @TomDLT quick review?

@jeremiedbb
Copy link
Member

Is it normal that it does not appear in the artifacts ?

@NicolasHug
Copy link
Member

It does, it's in the "Home" page https://101384-843222-gh.circle-artifacts.com/0/doc/index.html

Copy link
Member

@TomDLT TomDLT left a comment

Choose a reason for hiding this comment

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

I guess it makes sense to promote the highlights page, though I find that the link to the full changelog is now hard to find, both in the home page and in the highlights page.

@rth
Copy link
Member

rth commented Apr 30, 2020

I guess it makes sense to promote the highlights page, though I find that the link to the full changelog is now hard to find, both in the home page and in the highlights page.

Yes, I think I prefer to keep the link to what's new on the home page as in master. Highlights are good when announcing the release but being easily able to find release notes is more important IMO that highlights in the long term. Is there another place we can put the highlights on the home page?

@NicolasHug
Copy link
Member

I agree the what'snew is slightly less obvious now, but we should note that it's literally back where it was prior to 0.22, and we didn't seem to care at that time :p

@thomasjpfan
Copy link
Member Author

Adds the whats new back in, and a bit of styling to make sure there are always two buttons per row. (A purely aesthetic choice)

@NicolasHug NicolasHug dismissed their stale review April 30, 2020 19:00

not sure I like it anymore

@thomasjpfan
Copy link
Member Author

I'm going to stick with my personal preferred option for now, which is to only have "Getting Started", "Release Highlights", and "GitHub"

I think the highlights are more important to place "above the fold".

An alternative is to put the "Whats New" in the nav bar under "more".

@thomasjpfan
Copy link
Member Author

The whats new is now in the navbar under "more"

doc/themes/scikit-learn-modern/nav.html Outdated Show resolved Hide resolved
@ogrisel
Copy link
Member

ogrisel commented May 1, 2020

Could you also please manually add a direct link to the News section? That is 2 links in the parenthesis:

"December 2019. scikit-learn 0.22 is available for download (Changelog & Release Highlights)"

Screenshot from 2020-05-01 10-51-31

Copy link
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks very much!

@ogrisel ogrisel merged commit 5756205 into scikit-learn:master May 3, 2020
@ogrisel
Copy link
Member

ogrisel commented May 3, 2020

Tagging #17010.

adrinjalali pushed a commit to adrinjalali/scikit-learn that referenced this pull request May 4, 2020
gio8tisu pushed a commit to gio8tisu/scikit-learn that referenced this pull request May 15, 2020
viclafargue pushed a commit to viclafargue/scikit-learn that referenced this pull request Jun 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants