moving examples

Folks,

The examples have been getting a lot of attention recently (much credit to
Nelle who is leading that effort) which is great! However I am a bit
worried about moving/renaming examples as it will break peoples bookmarks.

How much do we care about that (I may be being overly worried/cautious
here)? What are our options for leaving bread-crumbs / forwards for people?

Tom
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/matplotlib-devel/attachments/20170213/919c69b9/attachment.html>

Hi Thomas,

I guess the less imaginative solution may be a simple page referencing the URLs that have changed. Something as simple as:

                    Former URL | Current URL |
--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
[a_random_pyplot_example](http://matplotlib.org/examples/api/a_random_pyplot_example.html) | [a_random_example_pyplot](http://matplotlib.org/examples/pyplot/a_random_pyplot_example.html) |
                                        ... | ... |
[a_deleted_example_pyplot](http://matplotlib.org/examples/api/an_deprecated_example.html) | This example was deleted |

which would then be referenced on the main page (maybe in the ?Documentation? section, as the links for the previous docs.)

My 2 cents,
Adrien

Le 13/02/2017 ? 06:20, Thomas Caswell a ?crit :

···

Folks,

The examples have been getting a lot of attention recently (much credit
to Nelle who is leading that effort) which is great! However I am a bit
worried about moving/renaming examples as it will break peoples bookmarks.

How much do we care about that (I may be being overly worried/cautious
here)? What are our options for leaving bread-crumbs / forwards for people?

Tom

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

It's a shame that the main documentation does not redirect to the versioned
documentation. It would be nice it the only pages bookmarked would be
matplotlib.org/majorversion/examples/... that way we would get the best of
both worlds imho. If we can find a simple way of generating redirects as
Adrien suggests that sounds reasonable too. I think we should try hard to
find a way to move the pylab examples to a folders with a more meaningful
name as well as deleting a fair number of examples

Jens

···

On Mon, 13 Feb 2017 at 08:32 vincent.adrien at gmail.com < vincent.adrien at gmail.com> wrote:

Hi Thomas,

I guess the less imaginative solution may be a simple page referencing the
URLs that have changed. Something as simple as:

> Former URL |
                                 Current URL
                                               >

>--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
> [a_random_pyplot_example](
http://matplotlib.org/examples/api/a_random_pyplot_example.html) |
[a_random_example_pyplot](
http://matplotlib.org/examples/pyplot/a_random_pyplot_example.html) |
> ...
                  >
   ... |
> [a_deleted_example_pyplot](
http://matplotlib.org/examples/api/an_deprecated_example.html) |
                          This example was deleted
                   >

which would then be referenced on the main page (maybe in the
?Documentation? section, as the links for the previous docs.)

My 2 cents,
Adrien

Le 13/02/2017 ? 06:20, Thomas Caswell a ?crit :
> Folks,
>
> The examples have been getting a lot of attention recently (much credit
> to Nelle who is leading that effort) which is great! However I am a bit
> worried about moving/renaming examples as it will break peoples
bookmarks.
>
> How much do we care about that (I may be being overly worried/cautious
> here)? What are our options for leaving bread-crumbs / forwards for
people?
>
> Tom
>
>
> _______________________________________________
> Matplotlib-devel mailing list
> Matplotlib-devel at python.org
> https://mail.python.org/mailman/listinfo/matplotlib-devel
>

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/matplotlib-devel/attachments/20170213/3172deb6/attachment.html>

It's a shame that the main documentation does not redirect to the
versioned documentation. It would be nice it the only pages bookmarked
would be
matplotlib.org/majorversion/examples/... that way we would get the best
of both worlds imho. If we can find a simple way of generating redirects as
Adrien suggests that sounds reasonable too. I think we should try hard to
find a way to move the pylab examples to a folders with a more meaningful
name as well as deleting a fair number of examples

Somewhat related to deleting examples, do we have any kind of analytics on
our website frequency usage? something like google analytics. It could help
us see what people are using in our documentation.

Jens

Hi Thomas,

I guess the less imaginative solution may be a simple page referencing
the URLs that have changed. Something as simple as:

> Former URL |
                                 Current URL
                                               >
>-----------------------------------------------------------
---------------------------------|--------------------------
----------------------------------------------------------------------|
> [a_random_pyplot_example](http://matplotlib.org/examples/
api/a_random_pyplot_example.html) | [a_random_example_pyplot](http
://matplotlib.org/examples/pyplot/a_random_pyplot_example.html) |
> ...
                    >
     ... |
> [a_deleted_example_pyplot](http://matplotlib.org/examples/
api/an_deprecated_example.html) | This
example was deleted |

which would then be referenced on the main page (maybe in the
?Documentation? section, as the links for the previous docs.)

My 2 cents,
Adrien

Le 13/02/2017 ? 06:20, Thomas Caswell a ?crit :
> Folks,
>
> The examples have been getting a lot of attention recently (much credit
> to Nelle who is leading that effort) which is great! However I am a bit
> worried about moving/renaming examples as it will break peoples
bookmarks.
>
> How much do we care about that (I may be being overly worried/cautious
> here)? What are our options for leaving bread-crumbs / forwards for
people?
>
> Tom
>
>
> _______________________________________________
> Matplotlib-devel mailing list
> Matplotlib-devel at python.org
> https://mail.python.org/mailman/listinfo/matplotlib-devel
>

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/matplotlib-devel/attachments/20170213/ea144e79/attachment.html>

···

On Mon, 13 Feb 2017 at 08:32 vincent.adrien at gmail.com < > vincent.adrien at gmail.com> wrote:

yes, i will give access to anyone who wants.

···

On Mon, Feb 13, 2017, 19:38 Nelle Varoquaux <nelle.varoquaux at gmail.com> wrote:

It's a shame that the main documentation does not redirect to the
versioned documentation. It would be nice it the only pages bookmarked
would be
matplotlib.org/majorversion/examples/... that way we would get the best
of both worlds imho. If we can find a simple way of generating redirects as
Adrien suggests that sounds reasonable too. I think we should try hard to
find a way to move the pylab examples to a folders with a more meaningful
name as well as deleting a fair number of examples

Somewhat related to deleting examples, do we have any kind of analytics on
our website frequency usage? something like google analytics. It could help
us see what people are using in our documentation.

Jens

On Mon, 13 Feb 2017 at 08:32 vincent.adrien at gmail.com < > vincent.adrien at gmail.com> wrote:

Hi Thomas,

I guess the less imaginative solution may be a simple page referencing the
URLs that have changed. Something as simple as:

> Former URL |
                                 Current URL
                                               >

>--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
> [a_random_pyplot_example](
http://matplotlib.org/examples/api/a_random_pyplot_example.html) |
[a_random_example_pyplot](
http://matplotlib.org/examples/pyplot/a_random_pyplot_example.html) |
> ...
                  >
   ... |
> [a_deleted_example_pyplot](
http://matplotlib.org/examples/api/an_deprecated_example.html) |
                          This example was deleted
                   >

which would then be referenced on the main page (maybe in the
?Documentation? section, as the links for the previous docs.)

My 2 cents,
Adrien

Le 13/02/2017 ? 06:20, Thomas Caswell a ?crit :
> Folks,
>
> The examples have been getting a lot of attention recently (much credit
> to Nelle who is leading that effort) which is great! However I am a bit
> worried about moving/renaming examples as it will break peoples
bookmarks.
>
> How much do we care about that (I may be being overly worried/cautious
> here)? What are our options for leaving bread-crumbs / forwards for
people?
>
> Tom
>
>
> _______________________________________________
> Matplotlib-devel mailing list
> Matplotlib-devel at python.org
> https://mail.python.org/mailman/listinfo/matplotlib-devel
>

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/matplotlib-devel/attachments/20170214/59e98701/attachment-0001.html>

yes, i will give access to anyone who wants.

It's a shame that the main documentation does not redirect to the
versioned documentation. It would be nice it the only pages bookmarked
would be
matplotlib.org/majorversion/examples/... that way we would get the best
of both worlds imho. If we can find a simple way of generating redirects as
Adrien suggests that sounds reasonable too. I think we should try hard to
find a way to move the pylab examples to a folders with a more meaningful
name as well as deleting a fair number of examples

Somewhat related to deleting examples, do we have any kind of analytics
on our website frequency usage? something like google analytics. It could
help us see what people are using in our documentation.

I am interested: I think it should help us see which examples are
frequently accessed and those which aren't, and could help us merging some
examples together.

I also think we shouldn't be too concerned with breaking people's
bookmarks: if someone has a broken bookmark, it is fairly easy to google
for the replacement.
If renaming, moving or deleting an example makes our life easier, I think
we should go forward with that.

My 2 cents,
N

Jens

Hi Thomas,

I guess the less imaginative solution may be a simple page referencing
the URLs that have changed. Something as simple as:

> Former URL |
                                 Current URL
                                               >
>-----------------------------------------------------------
---------------------------------|--------------------------
----------------------------------------------------------------------|
> [a_random_pyplot_example](http://matplotlib.org/examples/
api/a_random_pyplot_example.html) | [a_random_example_pyplot](http
://matplotlib.org/examples/pyplot/a_random_pyplot_example.html) |
> ...
                    >
     ... |
> [a_deleted_example_pyplot](http://matplotlib.org/examples/
api/an_deprecated_example.html) | This
example was deleted |

which would then be referenced on the main page (maybe in the
?Documentation? section, as the links for the previous docs.)

My 2 cents,
Adrien

Le 13/02/2017 ? 06:20, Thomas Caswell a ?crit :
> Folks,
>
> The examples have been getting a lot of attention recently (much credit
> to Nelle who is leading that effort) which is great! However I am a bit
> worried about moving/renaming examples as it will break peoples
bookmarks.
>
> How much do we care about that (I may be being overly worried/cautious
> here)? What are our options for leaving bread-crumbs / forwards for
people?
>
> Tom
>
>
> _______________________________________________
> Matplotlib-devel mailing list
> Matplotlib-devel at python.org
> https://mail.python.org/mailman/listinfo/matplotlib-devel
>

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/matplotlib-devel/attachments/20170214/d0fd7749/attachment.html>

···

On 13 February 2017 at 16:40, Thomas Caswell <tcaswell at gmail.com> wrote:

On Mon, Feb 13, 2017, 19:38 Nelle Varoquaux <nelle.varoquaux at gmail.com> > wrote:

On Mon, 13 Feb 2017 at 08:32 vincent.adrien at gmail.com < >> vincent.adrien at gmail.com> wrote:

I am not too worried about bookmarks. Rather, it is tutorials. We have no
mechanism for permalinking specific examples, which means tutorials
eventually break. It isn't utterly terrible, but it is annoying. I wouldn't
use it as a reason to not re-organize examples at all (it isn't API), but I
wouldn't make a habit of reorganizing things every few releases.

···

On Tue, Feb 14, 2017 at 4:54 PM, Nelle Varoquaux <nelle.varoquaux at gmail.com> wrote:

On 13 February 2017 at 16:40, Thomas Caswell <tcaswell at gmail.com> wrote:

yes, i will give access to anyone who wants.

On Mon, Feb 13, 2017, 19:38 Nelle Varoquaux <nelle.varoquaux at gmail.com> >> wrote:

It's a shame that the main documentation does not redirect to the
versioned documentation. It would be nice it the only pages bookmarked
would be
matplotlib.org/majorversion/examples/... that way we would get the best
of both worlds imho. If we can find a simple way of generating redirects as
Adrien suggests that sounds reasonable too. I think we should try hard to
find a way to move the pylab examples to a folders with a more meaningful
name as well as deleting a fair number of examples

Somewhat related to deleting examples, do we have any kind of analytics
on our website frequency usage? something like google analytics. It could
help us see what people are using in our documentation.

I am interested: I think it should help us see which examples are
frequently accessed and those which aren't, and could help us merging some
examples together.

I also think we shouldn't be too concerned with breaking people's
bookmarks: if someone has a broken bookmark, it is fairly easy to google
for the replacement.
If renaming, moving or deleting an example makes our life easier, I think
we should go forward with that.

My 2 cents,
N

Jens

On Mon, 13 Feb 2017 at 08:32 vincent.adrien at gmail.com < >>> vincent.adrien at gmail.com> wrote:

Hi Thomas,

I guess the less imaginative solution may be a simple page referencing
the URLs that have changed. Something as simple as:

> Former URL |
                                   Current URL
                                                 >
>-----------------------------------------------------------
---------------------------------|--------------------------
----------------------------------------------------------------------|
> [a_random_pyplot_example](http://matplotlib.org/examples/api
/a_random_pyplot_example.html) | [a_random_example_pyplot](http
://matplotlib.org/examples/pyplot/a_random_pyplot_example.html) |
> ...
                    >
     ... |
> [a_deleted_example_pyplot](http://matplotlib.org/examples/ap
i/an_deprecated_example.html) | This
example was deleted |

which would then be referenced on the main page (maybe in the
?Documentation? section, as the links for the previous docs.)

My 2 cents,
Adrien

Le 13/02/2017 ? 06:20, Thomas Caswell a ?crit :
> Folks,
>
> The examples have been getting a lot of attention recently (much credit
> to Nelle who is leading that effort) which is great! However I am a
bit
> worried about moving/renaming examples as it will break peoples
bookmarks.
>
> How much do we care about that (I may be being overly worried/cautious
> here)? What are our options for leaving bread-crumbs / forwards for
people?
>
> Tom
>
>
> _______________________________________________
> Matplotlib-devel mailing list
> Matplotlib-devel at python.org
> https://mail.python.org/mailman/listinfo/matplotlib-devel
>

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/matplotlib-devel/attachments/20170214/ac2c96d2/attachment-0001.html>

I would favor accepting a one-time breakage (as others mentioned it's
really not that bad), and start versioning the docs (redirect matplotlib.org
to matplotlib.org/$latest_ver and so on). See also
https://www.python.org/dev/peps/pep-0430/.

2017-02-14 14:25 GMT-08:00 Benjamin Root <ben.v.root at gmail.com>:

I am not too worried about bookmarks. Rather, it is tutorials. We have no
mechanism for permalinking specific examples, which means tutorials
eventually break. It isn't utterly terrible, but it is annoying. I wouldn't
use it as a reason to not re-organize examples at all (it isn't API), but I
wouldn't make a habit of reorganizing things every few releases.

yes, i will give access to anyone who wants.

It's a shame that the main documentation does not redirect to the
versioned documentation. It would be nice it the only pages bookmarked
would be
matplotlib.org/majorversion/examples/... that way we would get the
best of both worlds imho. If we can find a simple way of generating
redirects as Adrien suggests that sounds reasonable too. I think we should
try hard to find a way to move the pylab examples to a folders with a more
meaningful name as well as deleting a fair number of examples

Somewhat related to deleting examples, do we have any kind of analytics
on our website frequency usage? something like google analytics. It could
help us see what people are using in our documentation.

I am interested: I think it should help us see which examples are
frequently accessed and those which aren't, and could help us merging some
examples together.

I also think we shouldn't be too concerned with breaking people's
bookmarks: if someone has a broken bookmark, it is fairly easy to google
for the replacement.
If renaming, moving or deleting an example makes our life easier, I think
we should go forward with that.

My 2 cents,
N

Jens

Hi Thomas,

I guess the less imaginative solution may be a simple page referencing
the URLs that have changed. Something as simple as:

> Former URL |
                                   Current URL
                                                 >
>-----------------------------------------------------------
---------------------------------|--------------------------
----------------------------------------------------------------------|
> [a_random_pyplot_example](http://matplotlib.org/examples/api
/a_random_pyplot_example.html) | [a_random_example_pyplot](http
://matplotlib.org/examples/pyplot/a_random_pyplot_example.html) |
> ...
                      >
       ... |
> [a_deleted_example_pyplot](http://matplotlib.org/examples/ap
i/an_deprecated_example.html) | This
example was deleted |

which would then be referenced on the main page (maybe in the
?Documentation? section, as the links for the previous docs.)

My 2 cents,
Adrien

Le 13/02/2017 ? 06:20, Thomas Caswell a ?crit :
> Folks,
>
> The examples have been getting a lot of attention recently (much
credit
> to Nelle who is leading that effort) which is great! However I am a
bit
> worried about moving/renaming examples as it will break peoples
bookmarks.
>
> How much do we care about that (I may be being overly worried/cautious
> here)? What are our options for leaving bread-crumbs / forwards for
people?
>
> Tom
>
>
> _______________________________________________
> Matplotlib-devel mailing list
> Matplotlib-devel at python.org
> https://mail.python.org/mailman/listinfo/matplotlib-devel
>

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

_______________________________________________
Matplotlib-devel mailing list
Matplotlib-devel at python.org
https://mail.python.org/mailman/listinfo/matplotlib-devel

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/matplotlib-devel/attachments/20170214/b003d6ce/attachment-0001.html>

···

On Tue, Feb 14, 2017 at 4:54 PM, Nelle Varoquaux < > nelle.varoquaux at gmail.com> wrote:

On 13 February 2017 at 16:40, Thomas Caswell <tcaswell at gmail.com> wrote:

On Mon, Feb 13, 2017, 19:38 Nelle Varoquaux <nelle.varoquaux at gmail.com> >>> wrote:

On Mon, 13 Feb 2017 at 08:32 vincent.adrien at gmail.com < >>>> vincent.adrien at gmail.com> wrote: