Re: Doc comments on unsupported versions

From: Magnus Hagander <magnus(at)hagander(dot)net>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: "Jonathan S(dot) Katz" <jkatz(at)postgresql(dot)org>, Daniel Gustafsson <daniel(at)yesql(dot)se>, PostgreSQL www <pgsql-www(at)postgresql(dot)org>
Subject: Re: Doc comments on unsupported versions
Date: 2018-02-19 14:02:29
Message-ID: CABUevEyF6w-9+N4ZdW7L-e2MoRU=GMxwDJT-C9SbR74q51oG9w@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-www

On Mon, Feb 19, 2018 at 6:09 AM, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:

> "Jonathan S. Katz" <jkatz(at)postgresql(dot)org> writes:
> >> On Feb 17, 2018, at 1:35 PM, Magnus Hagander <magnus(at)hagander(dot)net>
> wrote:
> >> I think yes, let's drop it for unsupported versions. The more we can
> make it clear to people that they're unsupported, the better.
>
> > Just to argue the other side, just because the versions are unsupported
> > does not mean that people are not using those versions and at scale.
> > If there is something that is erroneous in the documentation, it would
> > not hurt to fix it, and there is a chance it is incorrect in a supported
> version.
>
> I can't see that we'd expend the effort to fix documentation in
> de-supported versions. But certainly, if someone were to point out an
> error that also exists in supported versions, we'd wish to fix it in the
> supported versions. Is there a way, rather than just blocking comments on
> the old versions, to provide a message to the effect of "please comment
> on version x.y or newer, if the issue still exists there"?
>

That is pretty much what Daniels patch does (except it writes it too many
times, but the general idea). It has:

+ If you see anything in the documentation that is not
correct, does not match
+ your experience with the particular feature or requires
further clarification,
+ please check if this has been fixed in the
+ <a href="/docs/current/static/{{page.file}}/">current
version</a> of the documentation. If
+ not, please report a documentation issue using the form on
that page.

(text of course easily tweakable)

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

In response to

Responses

Browse pgsql-www by date

  From Date Subject
Next Message Isaac Vakili 2018-02-19 22:11:00 Certification Verification connection problem during Postgresql 10.2 on window 7 64 bit from Stack build GUI section
Previous Message Magnus Hagander 2018-02-19 14:01:25 Re: Doc comments on unsupported versions