Re: GSoD - a patch for Getting Started tutorial

From: Laurenz Albe <laurenz(dot)albe(at)cybertec(dot)at>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Liudmila Mantrova <l(dot)mantrova(at)gmail(dot)com>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org, Stephen Frost <sfrost(at)snowman(dot)net>, Sarah Conway Schnurr <xenophenes42(at)gmail(dot)com>
Subject: Re: GSoD - a patch for Getting Started tutorial
Date: 2019-11-20 10:29:12
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-docs

On Tue, 2019-11-19 at 10:58 -0500, Tom Lane wrote:
> > i'm all for linking to the download page for the exact install commands
> > (which I did), but i see no harm in mentioning e.g. install/data
> > directories in documentation. It is something I myself went back to when
> > working on this tutorial update, so I believe the user will do too. But
> > let's hope we'll hear other opinions as well before I go and rework it all.
> Traditionally we've stayed away from this on the grounds that we don't
> control packaging details and so we wouldn't know when whatever we say
> becomes obsolete. Moreover, packaging changes tend not to be quantized
> to happen in sync with Postgres releases, so that even if we know
> something changed, there'd be a delay to get the word out.
> Maybe those arguments can be discounted if the proposal is *only* to
> document the PGDG packages, but will such a restricted solution really
> satisfy anyone? I'm concerned that novices will not realize that the
> presented details don't apply to whatever vendor-supplied Postgres
> they are using. This thread already presents a great example in its
> confusion over what the default auth method is on Red Hat packages.

The confusion was my fault because I didn't follow the tutorial,
but the point is valid (others may make similar blunders).

I think that the danger of changing paths in the PGDG binaries is

It might be a good idea to provide links to the documentation of
other popular binary distributions, e.g. for MacOS. We can add a
disclaimer that details can differ on these platforms.

I kind of like the "troubleshooting" section, but I am unsure where
to set the limit. What is there currently doesn't cover all
potential causes (e.g., connection via TCP, see Windows), but
being exhaustive is probably impossible and not even desirable.

On the one hand I can see this section as being helpful for the
host of people who are having problems connecting, on the other hand
the true beginner might have trouble understanding explanations
containing terms like "absolute path" and "Unix-domain sockets".

(Side remark: I think the spelling should be "UNIX domain sockets".)

I'd be sorry if this effort goes to waste, and there are valuable
additions here.

I think that the material in this patch is an improvement over
the "Installation" section in the current tutorial, but that the
other sections ("Architectural Fundamentals", "Creating a Database"
and "Accessing a Database") are better in the original.

And I like the idea of a "troubleshooting" section.

Laurenz Albe

In response to


Browse pgsql-docs by date

  From Date Subject
Next Message Daniel Gustafsson 2019-11-20 13:58:54 Odd markup in SSL mode table
Previous Message Laurenz Albe 2019-11-20 09:23:58 Re: GSoD - a patch for Getting Started tutorial