Examples page version is out of date #9556
Comments
|
This came up on gitter yesterday https://gitter.im/matplotlib/matplotlib?at=59ee111df7299e8f53218190 There are a couple of pages that were rename as part of the documentation overhaul that need to either have symlinks or forwards put in their place. We don't have direct access to the server so I don't think we can get it return 301s . The current state is likely better than people getting 404s. |
|
What do i do? |
|
Fun fact: github has a maximum comment length! I am not sure of the best course of action here is. I think the first step is to sort out what files moved, see #8688 and to simply compare the contents of https://github.com/matplotlib/matplotlib.github.com/tree/master/2.0.2 and https://github.com/matplotlib/matplotlib.github.com/tree/master/2.1.0 Once we know what files are the problem and the scope of it what do we want to do about it? Do we just want to add symlinks to the moved pages (forever?)? Is there a way to do forwards via html (forever)? Do we want to re-generate all of the old-docs with a header warning it is outdated? Is there a way we can do that without regenerating all of the html (sed? js tricks?)? We are limited in that we host on githubpages so we can only post static files (no server side tuning). We probably should cross-reference the file list against the google-analytics on each page's usage to make sure we do not break everything. matplotlib/matplotlib.github.com#23 is a ham-fisted attempt to remove old files. Below is logs of various outputs. I have done some of the leg work, but there is still a bunch of analysis to do. |
|
Analytics |
|
Renames according to git |
|
The output of |
|
GA landing page data |
With a |
|
For what it's worth @tacaswell
I don't think that is true anymore — some of those old pages are downright misleading for modern users. |
|
Probably worth doing the |
|
There was the idea to have readthedocs-style versions. I don't remember exactly why it was not followed up on. Anyway, it seems quite straight forward:
These two bully points could be done immediately with little effort. Later one can
|
|
We already have versioned directories; we don't have |
|
The problem is not the current docs per-se, but the fact that the whole I think we should actually just redirect top-level |
|
At this point 404s are better than pointing to examples that likely do things in old ways that have improved, or worse do things using deprecated/removed APIs. It's the internet, links die. Let's just make sure our current docs don't somehow accidentally link there. |
|
I'll also add that we're not doing this willy nilly, but in the name of improving the overall situation for users. Having a top-level link like that be out-of-date is really confusing and a serious UX issue, let alone contributing to the issue of "matplotlib docs are hard to understand". |
|
Still may be worth getting rid of all top-level stuff in favor of a /latest link. Otherwise we'll have to clean out top-level with every release to prevent future outdated top-level pages. And if /latest/xyz does not exist, it may be easier from that to look for /3.0.0/xyz compared to if /xyz does not exist. |
|
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
On the current live docs, the examples page claims to be from release
2.0.2, but it should be2.1: http://matplotlib.org/examples/index.htmlThe text was updated successfully, but these errors were encountered: