Re: [PATCH] Cross-version navigation in documentation

From: Magnus Hagander <magnus(at)hagander(dot)net>
To: Andres Freund <andres(at)2ndquadrant(dot)com>
Cc: Marti Raudsepp <marti(at)juffo(dot)org>, pgsql-www <pgsql-www(at)postgresql(dot)org>, Stefan Kaltenbrunner <stefan(at)kaltenbrunner(dot)cc>
Subject: Re: [PATCH] Cross-version navigation in documentation
Date: 2012-06-05 10:02:27
Message-ID: CABUevEwBZQyZLq8rG6g9zub3C12CNT7M0SW_SS3kppthd5btXQ@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-www

On Tue, Jun 5, 2012 at 11:42 AM, Andres Freund <andres(at)2ndquadrant(dot)com> wrote:
> On Tuesday, June 05, 2012 10:59:54 AM Magnus Hagander wrote:
>> On Wed, May 30, 2012 at 11:58 AM, Marti Raudsepp <marti(at)juffo(dot)org> wrote:
>> > On Mon, May 28, 2012 at 2:44 PM, Andres Freund <andres(at)2ndquadrant(dot)com>
> wrote:
>> >> The amount of pages actually having been renamed isn't that big. Marti
>> >> opened up his version of the docs to me and I browsed along and even
>> >> between 7.4 and 9.1 I had a hard time finding pages where you would
>> >> expect a link from 7.4 forwards.
>> >
>> > Exactly. And people rely on page names right now anyway -- they find
>> > the page on Google and then just change the version number in the URL
>> > and see if it works. Either that, or they will read the wrong version.
>> > What I'm proposing solves >95% of the cases and I think that is good
>> > enough.
>>
>> Given that nobody has objecte,d I'm going to go ahead and do this.
> Great!
>
>> However - should we perhaps just list supported versions? Turns the query
>> into: versions =
>> DocPage.objects.filter(file=fullname).extra(where=['version IN (SELECT
>> tree FROM core_version WHERE
>> supported)']).order_by('-version').only('version', 'file')
>>
>> or if we do want to list all versions, we should somehow indicate
>> which versions are supported and not on this list as well, I think.
>> But I'm happy to just listed supported versions for now.
> I personally would like to see older versions there because every now and then
> I need to look something up for them, but its infrequent enough that I don't
> especially care.

Well, I'm happy to include those *IF* we add some sort of indication
that they aren't supported. Hmm. maybe just "this page in other
version" and "this page in unsupported versions".

I'll do some experimenting :)

--
 Magnus Hagander
 Me: http://www.hagander.net/
 Work: http://www.redpill-linpro.com/

In response to

Responses

Browse pgsql-www by date

  From Date Subject
Next Message Dave Page 2012-06-06 16:38:02 Re: [PATCH] Cross-version navigation in documentation
Previous Message Andres Freund 2012-06-05 09:42:33 Re: [PATCH] Cross-version navigation in documentation