Re: An improved README experience for PostgreSQL - Mailing list pgsql-hackers

From Andrew Atkinson
Subject Re: An improved README experience for PostgreSQL
Date
Msg-id CAG6XLE=tDjXQN0QzpcqU4DOy0odiLQKF0ANx3GC8k-+tKAU0PA@mail.gmail.com
Whole thread Raw
In response to Re: An improved README experience for PostgreSQL  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: An improved README experience for PostgreSQL
List pgsql-hackers
I've grabbed Nathan's patch, and pushed it to GitHub simply to preview the rendered Markdown there. This isn't intended to be reviewed, this is just for anyone else that's interested in easily seeing the HTML version of the Markdown file compared with the earlier one.

Nathan's direct conversion:

Original email version with more sections and content:

I agree that starting with the direct conversion is reasonable. Markdown "modernizes" the file using a popular plain text file format that's renderable.

However, I also think it would be cool to get some input on what the most useful 2-3 content items are for new developers and make any additions possible there. In writing this, I had an idea to ask about whether this topic could be covered as an upcoming PostgreSQL community blog post series. In theory, we could gather a variety of perspectives that way. That could make it less subjective if we see several people independently suggesting a particular wiki page for example, for inclusion in the README. I'll pursue that outside the mailing list and report back!



On Wed, Feb 28, 2024 at 1:36 PM Tom Lane <tgl@sss.pgh.pa.us> wrote:
Nathan Bossart <nathandbossart@gmail.com> writes:
> On Wed, Feb 28, 2024 at 01:08:03PM -0600, Nathan Bossart wrote:
>> -PostgreSQL Database Management System
>> -=====================================
>> +# PostgreSQL Database Management System

> This change can be omitted, which makes the conversion even simpler.

That's a pretty convincing proof-of-concept.  Let's just do this,
and then make sure to keep the file legible as plain text.

                        regards, tom lane

pgsql-hackers by date:

Previous
From: Melanie Plageman
Date:
Subject: Re: BitmapHeapScan streaming read user and prelim refactoring
Next
From: Daniel Gustafsson
Date:
Subject: Re: An improved README experience for PostgreSQL