Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Add a banner indicating docs are unreleased. #9003

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 1 commit into from
Aug 8, 2017

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Aug 7, 2017

We've been getting quite a lot of tickets asking about features that don't yet exist in the released versions, so add a banner indicating that the page is for the unreleased version. I chose to use tab10:red + bolding, which I hope is flashy enough to catch people's attention.

Also, point to a search for the same page in the latest released version. Unfortunately, there's no easy way to point to the exact same page, especially with all the moved examples lately.

cc @doraf

@QuLogic QuLogic added this to the 2.1 (next point release) milestone Aug 7, 2017
@tacaswell
Copy link
Member

@WeatherGod
Copy link
Member

WeatherGod commented Aug 7, 2017 via email

@QuLogic
Copy link
Member Author

QuLogic commented Aug 7, 2017

Ah yes, I should have checked the colours after bolding it all. How about just plain white?
screen shot 2017-08-07 at 16 24 00

@WeatherGod
Copy link
Member

WeatherGod commented Aug 7, 2017 via email

@QuLogic QuLogic force-pushed the doc-unreleased-banner branch from 4d42fde to 4702395 Compare August 7, 2017 20:34
@efiring
Copy link
Member

efiring commented Aug 7, 2017

Why is the second sentence a question linked to a search, instead of a simple link to the released docs?

@WeatherGod
Copy link
Member

WeatherGod commented Aug 7, 2017 via email

@dorafc
Copy link
Contributor

dorafc commented Aug 7, 2017

Only comment is to remove the text shadow and to highlight the link with an underline instead. The text shadow makes the text a bit tricky to read, while an underline is a more universal convention for identifying links.

Otherwise, the fixed header works really well

@QuLogic QuLogic force-pushed the doc-unreleased-banner branch from 4702395 to 383e0f1 Compare August 8, 2017 01:14
@QuLogic
Copy link
Member Author

QuLogic commented Aug 8, 2017

@dorafc
Copy link
Contributor

dorafc commented Aug 8, 2017

Just a heads up – this text-decoration syntax isn't well supported across browsers (http://caniuse.com/#feat=text-decoration). I'd advise either removing the "dotted" attribute altogether or breaking the CSS to text-decoration: underline; text-decoration-style: dotted; so that browsers that don't render the second rule will fall back to the solid underline

Also, point to a search for the same page in the latest released
version. Unfortunately, there's no easy way to point to the exact same
page, especially with all the moved pages.
@QuLogic QuLogic force-pushed the doc-unreleased-banner branch from 383e0f1 to 65ceda8 Compare August 8, 2017 02:52
Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

@tacaswell tacaswell merged commit 5a24121 into matplotlib:master Aug 8, 2017
@tacaswell
Copy link
Member

bah, accidentally squash-merged that.

Thanks everyone!

@QuLogic QuLogic deleted the doc-unreleased-banner branch August 8, 2017 19:34
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.

7 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.