| From: | "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com> |
|---|---|
| To: | Philip Alger <paalger0(at)gmail(dot)com> |
| Cc: | Dragos Andriciuc <dragos(dot)andriciuc(at)percona(dot)com>, Andreas Karlsson <andreas(at)proxel(dot)se>, "pgsql-hackers(at)postgresql(dot)org" <pgsql-hackers(at)postgresql(dot)org> |
| Subject: | Re: DOCS - Add introductory paragraph to Getting Started chapter |
| Date: | 2026-02-19 16:14:45 |
| Message-ID: | CAKFQuwZjMOKiLXUFPFLvxLRBzd=GLV6HXPzn4brsFbvHAQzufg@mail.gmail.com |
| Views: | Whole Thread | Raw Message | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-hackers |
On Thu, Feb 19, 2026 at 6:51 AM Philip Alger <paalger0(at)gmail(dot)com> wrote:
>
>
> On Thu, Feb 19, 2026 at 3:58 AM Dragos Andriciuc <
> dragos(dot)andriciuc(at)percona(dot)com> wrote:
>
>> Thanks for pointing that out. The intention was to add two paragraphs and
>> it is now corrected to use
>> two separate <para> tags. Attached is v2 of the patch.
>>
>> I have verified that the docs build and render correctly in HTML locally.
>>
>>>
>>>
> Hello,
>
> It's always good to add more documentation. I wouldn't consider two single
> sentences as separate paragraphs though.
>
> However, I think these sentences can be combined into one.
>
> For example:
>
> This chapter provides a practical introduction to
> <productname>PostgreSQL</productname>
> by guiding you through software installation, basic architectural
> concepts, and how to create and access
> your first database.
>
> I think this version combines the two essentially.
>
>
All that does is put the existing Table of Contents into paragraph form.
I'd keep the second sentence and let the ToC speak for itself personally.
Or put a bit more effort into saying something about those topics that a
ToC header cannot convey. I'm fine with the status quo though, at least
compared to the proposed.
Probably should make 'server', 'client' and 'database' links to the
glossary - though the architecture page will also provide detail if they
perform a linear read.
Looking at this more critically, why does installation come before
architecture? I would expect architecture to include information that
improves understanding what is being installed and why. Or, more
generally, theory before practice.
Suggestion:
<para>
[First] This chapter provides a brief introduction to the concepts and
terminology employed in PostgreSQL's design. [Then] It also walks you
through getting a server and client installed on your machine and ensuring
it is functioning by creating a new database and connecting to it via the
command line client.
</para>
David J.
| From | Date | Subject | |
|---|---|---|---|
| Next Message | Ants Aasma | 2026-02-19 16:16:57 | Re: Hash aggregate collisions cause excessive spilling |
| Previous Message | Andres Freund | 2026-02-19 16:13:41 | Re: add assertion for palloc in signal handlers |