Re: [DOCS] the sad state of our FAQs

From: Stefan Kaltenbrunner <stefan(at)kaltenbrunner(dot)cc>
To: Selena Deckelmann <selenamarie(at)gmail(dot)com>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Brendan Jurd <direvus(at)gmail(dot)com>, Alvaro Herrera <alvherre(at)commandprompt(dot)com>, PostgreSQL www <pgsql-www(at)postgresql(dot)org>, pgsql-docs(at)postgresql(dot)org
Subject: Re: [DOCS] the sad state of our FAQs
Date: 2009-03-08 00:30:06
Message-ID: 49B3118E.8060508@kaltenbrunner.cc
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-www

Selena Deckelmann wrote:
> On Mar 7, 2009, at 2:33 PM, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
>
>> Brendan Jurd <direvus(at)gmail(dot)com> writes:
>>> Although to be frank I think the value of per-version FAQs is dubious.
>>> I would be totally okay with seeing the back-branch FAQs abandoned in
>>> favour of the One FAQ (to rule them all, etc).
>>
>> I think it might well be true though that it'd be better to have one FAQ
>> with answers that say something like "Before version x.y, do this ...
>> in x.y and later, do that ...". That approach makes sure that people
>> know that they are reading version-specific advice; whereas the separate
>> FAQs approach makes it pretty easy for people to fail to notice that
>> they are reading advice that's inappropriate for their version.
>
> Another approach would be to tag each FAQ with what version it was
> created for and what version it is deprecated for. (pretty much what
> Brenden suggested, but slightly less overhead than listing all versions
> the FAQ applies to)
>
> Then we could do cool things like generate the version specific FAQs
> programmatically and not ever worry about removing them.

Yeah so some simple tags/icons like "8.1+, 7.4 only, 8.0 and older" on a
per entry base? We also could use something like an "outdated" template
for flagging specific entries or complete FAQ/wiki pages.
I don't really think that the per version FAQ is really a reality - we
only have one version on the main website (which is actually -HEAD I
think which makes it even more weird) and I really doubt that a lot of
people are reading them elsewhere.

Stefan

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Tatsuo Ishii 2009-03-08 07:51:01 Re: the sad state of our FAQs
Previous Message Guillaume Lelarge 2009-03-07 22:59:55 Re: the sad state of our FAQs

Browse pgsql-www by date

  From Date Subject
Next Message Alvaro Herrera 2009-03-08 01:00:12 archives.pg.org changes
Previous Message Guillaume Lelarge 2009-03-07 22:59:55 Re: the sad state of our FAQs