Re: [PATCH] Cross-version navigation in documentation

From: Magnus Hagander <magnus(at)hagander(dot)net>
To: Marti Raudsepp <marti(at)juffo(dot)org>
Cc: Andres Freund <andres(at)2ndquadrant(dot)com>, 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 08:59:54
Message-ID: CABUevExJFVOk4Xz4DVVKHvRAHuw7-23Uog0zsSKhagMbgXcJUA@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-www

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.

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.

Thoughts?

> On Sun, May 27, 2012 at 9:40 PM, Magnus Hagander <magnus(at)hagander(dot)net> wrote:
>> On Sunday, May 27, 2012, Marti Raudsepp wrote:
>>> PS: Python projects have a nearly universal style of using 4-space
>>> indents (PEP-0008).
>
>> I don't really see the point. If your editor can't be consistent about
>> tabs/spaces, you probably have a bigger problem
>
> Well I need to reconfigure my editor to edit these files.

I'm sure you can instruct it to reconfigure itself once you know it
though ;) (based on pathname or such)

--
 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 Andres Freund 2012-06-05 09:42:33 Re: [PATCH] Cross-version navigation in documentation
Previous Message Magnus Hagander 2012-06-05 06:07:33 Re: Broken links