public inbox for [email protected]
help / color / mirror / Atom feedFrom: Liudmila Mantrova <[email protected]>
To: Tom Lane <[email protected]>
Cc: Laurenz Albe <[email protected]>
Cc: [email protected]
Cc: Stephen Frost <[email protected]>
Cc: Sarah Conway Schnurr <[email protected]>
Subject: Re: GSoD - a patch for Getting Started tutorial
Date: Thu, 21 Nov 2019 20:06:24 +0300
Message-ID: <CAEkD-mBFQb61gHNWR0cN5K4G4q-i1PRwNn_OKVkKSaaJa5_LbA@mail.gmail.com> (raw)
In-Reply-To: <[email protected]>
References: <CAEkD-mAxCk_mX_RwjyxBLHEjt_T5-mS-c6ryfh3nBjdbyYMC0g@mail.gmail.com>
<[email protected]>
<CAEkD-mD-A1p=xZ7URBM4L5KUap63MQMYh9x1QTTtyFHX+5QcQQ@mail.gmail.com>
<[email protected]>
<CAEkD-mB2E90p_hH4qSkxqMQ1KDA_owy3zHz_V3zcwAxZVRKwDA@mail.gmail.com>
<[email protected]>
<[email protected]>
<[email protected]>
On Wed, Nov 20, 2019 at 6:13 PM Tom Lane <[email protected]> wrote:
> Laurenz Albe <[email protected]> writes:
> > 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.
>
Thank you for your feedback! I'll be glad even if some part of this patch
improves the getting started experience for novice users, so I can focus on
the install and troubleshooting first. I would limit troubleshooting to
those issues that might appear when we follow the tutorial. As you've
already mentioned, Windows is not covered right now, so once I add it, I
can add the Windows-specific connection issues too. However, if we cover
Windows, I think it's logical to include PGDG Linux packages as well.
>
> > 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".
>
> As far as that goes, Corey's nearby proposal to add a glossary
> could be a great help. We could define such terms there, and
> make the tutorial's uses of them be hyperlinks. So maybe we
> should get that done first, and then come back to this?
>
I agree that having links to a glossary can be quite valuable. However, I
have some doubts about including each and every computer-related term -
should we keep it more DBMS-specific? As for the "absolute path" in
particular, I hope the example that follows clarifies things.
> > (Side remark: I think the spelling should be "UNIX domain sockets".)
>
> FWIW, I think we've used the first spelling in most places.
> Which is more "correct", I don't know, but I'm pretty sure
> that spelling Unix in all-caps has been out of fashion for
> a very long time.
>
Right, I've been following the spelling that seems to be widely used in
documentation. My preference is to use it without a hyphen, but then we'd
have to change the spelling everywhere in our docs.
--
Best regards,
Liudmila Mantrova
Technical writer at Postgres Professional: http://www.postgrespro.com
view thread (10+ messages)
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: [email protected]
Cc: [email protected], [email protected], [email protected], [email protected], [email protected], [email protected]
Subject: Re: GSoD - a patch for Getting Started tutorial
In-Reply-To: <CAEkD-mBFQb61gHNWR0cN5K4G4q-i1PRwNn_OKVkKSaaJa5_LbA@mail.gmail.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox