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

Display warning on out-of-date documentation websites #9553

Closed
fkohlgrueber opened this issue Oct 24, 2017 · 3 comments
Closed

Display warning on out-of-date documentation websites #9553

fkohlgrueber opened this issue Oct 24, 2017 · 3 comments
Assignees
Milestone

Comments

@fkohlgrueber
Copy link
Contributor

I was already beginning to file a ticket here because I didn't find any information about pytest in the docs until I realized that I've been using an old documentation page.

I was using https://matplotlib.org/2.0.2/devel/contributing.html instead of https://matplotlib.org/devel/contributing.html

As it is now, it's hard to see that you're using the documentation of an old version, and if you're not paying attention to the URL, you might not realize it.

Would it be possible to display a warning on all websites of old versions? Something like the warning displayed here but with a text like "This is the documentation of Matplotlib 2.0.2. Click here to view the documentation of the latest version."

One could argue that these old version documentation websites are only used by people who explicitly search for it, but I think that that's not true. I (somehow) managed to use the websites above, most likely because I was using google to get to the documentation.

@tacaswell tacaswell added this to the v2.1.0-doc milestone Oct 24, 2017
@tacaswell
Copy link
Member

I think our pages are systematic enough that it should be possible to inject that banner into the old docs.

@anntzer
Copy link
Contributor

anntzer commented Oct 27, 2017

Similarly note the confusion between
https://matplotlib.org/api/_as_gen/matplotlib.pyplot.pcolor.html#matplotlib.pyplot.pcolor (2.1.0)
and
https://matplotlib.org/api/pyplot_api.html (2.0.2, google also pointed me there...)

(there's actually nothing that warns that it's 2.0.2, except the page title...)

@QuLogic
Copy link
Member

QuLogic commented Feb 12, 2021

Canonical links and redirects were added in matplotlib/matplotlib.github.com#49. There is also a banner noting that the page is outdated at the top of the page.

@QuLogic QuLogic closed this as completed Feb 12, 2021
@QuLogic QuLogic modified the milestones: v2.2-doc, v3.4.0 Feb 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants