Re: User documentation vs Official Docs

From: Vick Khera <vivek(at)khera(dot)org>
To: "Psql_General (E-mail)" <pgsql-general(at)postgresql(dot)org>
Subject: Re: User documentation vs Official Docs
Date: 2018-07-16 21:54:59
Message-ID: CALd+dcdnLtX0+icgAVFXpMfMURNkfO=y+wM_RQtCJnyNw81Rpg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-general

On Mon, Jul 16, 2018 at 5:44 PM, Joshua D. Drake <jd(at)commandprompt(dot)com>
wrote:

> On 07/16/2018 02:22 PM, Joshua D. Drake wrote:
>
>> On 07/16/2018 01:59 PM, Stephen Frost wrote:
>>
>>>
>>> We have a place for this to go, in the official docs, already split out
>>> by version, and it starts here:
>>>
>>> https://www.postgresql.org/docs/10/static/tutorial-start.html
>>>
>>> Adding more to that certainly sounds good to me.
>>>
>>
>> I didn't know that existed. I will take a look.
>
>
> Well now that I see it is just the "tutorial" in the official docs, I
> disagree that is the correct place to start. At least not if it is going to
> ship with the 1000+ pages of documentation we already have. What I am
> envisioning is something with a strong SEO that gives pointed and direct
> information about solving a specific problem. A tutorial book could
> certainly do that as could (what I am really talking about) is Postgres
> recipes or something like that.
>
>

I didn't know it existed either, mostly because I know how to ask google to
do things, and the things I need to know are not covered here (yet). This
does seem to me to be the ideal place to add more how to documentation to
augment all the reference docs we have.

As for some "strong SEO" I think already the top hit for almost everything
I seek postgres related is the official manual, so it seems to have good
SEO. The only big improvement would be somehow to tell google to only show
me the newest version of the manual, not all of the older ones too, for the
same page.

In response to

Responses

Browse pgsql-general by date

  From Date Subject
Next Message Joshua D. Drake 2018-07-16 21:59:42 Re: User documentation vs Official Docs
Previous Message Alessandro Aste 2018-07-16 21:50:45 Re: Query to monitor index bloat