pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedSuggestion to improve PostgreSQL documentation clarity
2+ messages / 2 participants
[nested] [flat]
* Suggestion to improve PostgreSQL documentation clarity
@ 2026-07-12 16:09 PG Doc comments form <noreply@postgresql.org>
2026-07-13 14:42 ` Re: Suggestion to improve PostgreSQL documentation clarity Laurenz Albe <laurenz.albe@cybertec.at>
0 siblings, 1 reply; 2+ messages in thread
From: PG Doc comments form @ 2026-07-12 16:09 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: bilalabdulkadir286@gmail.com
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/18/source-format.html
Description:
Hello PostgreSQL Documentation Team,
I am a PostgreSQL learner and community member. While studying PostgreSQL
documentation and working on database projects, I found that some sections
could benefit from additional beginner-friendly explanations and practical
examples.
I suggest adding more step-by-step examples for new users, especially around
database setup, connection configuration, user privileges, security
settings, and common migration workflows.
Clear examples showing real-world scenarios would help learners and
developers understand PostgreSQL concepts more easily and reduce confusion
when applying the documentation in practice.
Thank you for maintaining excellent PostgreSQL documentation and for
considering this suggestion.
Best regards,
Bilal Abdulkadir Muhammed
^ permalink raw reply [nested|flat] 2+ messages in thread
* Re: Suggestion to improve PostgreSQL documentation clarity
2026-07-12 16:09 Suggestion to improve PostgreSQL documentation clarity PG Doc comments form <noreply@postgresql.org>
@ 2026-07-13 14:42 ` Laurenz Albe <laurenz.albe@cybertec.at>
0 siblings, 0 replies; 2+ messages in thread
From: Laurenz Albe @ 2026-07-13 14:42 UTC (permalink / raw)
To: bilalabdulkadir286@gmail.com; pgsql-docs@lists.postgresql.org
On Sun, 2026-07-12 at 16:09 +0000, PG Doc comments form wrote:
> I am a PostgreSQL learner and community member. While studying PostgreSQL
> documentation and working on database projects, I found that some sections
> could benefit from additional beginner-friendly explanations and practical
> examples.
>
> I suggest adding more step-by-step examples for new users, especially around
> database setup, connection configuration, user privileges, security
> settings, and common migration workflows.
I am not certain if the documentation is the correct place for that.
There is a difference between documentation and a tutorial, and mixing
them won't be a service to anybody.
Now the documentation already contains examples, and those are clearly
fine (and more of them might be appropriate occasionally).
But step-by-step examples for new learners wouldn't be good.
However, the documentation contains a small tutorial, and there your
proposed additions would be fine.
Yours,
Laurenz Albe
^ permalink raw reply [nested|flat] 2+ messages in thread
end of thread, other threads:[~2026-07-13 14:42 UTC | newest]
Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2026-07-12 16:09 Suggestion to improve PostgreSQL documentation clarity PG Doc comments form <noreply@postgresql.org>
2026-07-13 14:42 ` Laurenz Albe <laurenz.albe@cybertec.at>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox