Re: An improved README experience for PostgreSQL

From: Nathan Bossart <nathandbossart(at)gmail(dot)com>
To: Daniel Gustafsson <daniel(at)yesql(dot)se>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Andrew Atkinson <andyatkinson(at)gmail(dot)com>, PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>, samay(at)tembo(dot)io
Subject: Re: An improved README experience for PostgreSQL
Date: 2024-02-28 17:02:37
Message-ID: 20240228170237.GB2435539@nathanxps13
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Wed, Feb 28, 2024 at 02:46:11PM +0100, Daniel Gustafsson wrote:
>> On 26 Feb 2024, at 21:30, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
>> Nathan Bossart <nathandbossart(at)gmail(dot)com> writes:
>>> I think this would be nice. If the Markdown version is reasonably readable
>>> as plain-text, maybe we could avoid maintaining two READMEs files, too.
>>> But overall, +1 to modernizing the README a bit.
>>
>> Per past track record, we change the top-level README only once every
>> three years or so, so I doubt it'd be too painful to maintain two
>> versions of it.
>
> It wont be, and we kind of already have two since there is another similar
> README displayed at https://www.postgresql.org/ftp/. That being said, a
> majority of those reading the README will likely be new developers accustomed
> to Markdown (or doing so via interfaces such as Github) so going to Markdown
> might not be a bad idea. We can also render a plain text version with pandoc
> for release builds should we want to.

Sorry, my suggestion wasn't meant to imply that I have any strong concerns
about maintaining two README files. If we can automate generating one or
the other, that'd be great, but I don't see that as a prerequisite to
adding a Markdown version.

--
Nathan Bossart
Amazon Web Services: https://aws.amazon.com

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Nathan Bossart 2024-02-28 17:10:48 Re: An improved README experience for PostgreSQL
Previous Message Nathan Bossart 2024-02-28 16:55:23 Re: MAINTAIN privilege -- what do we need to un-revert it?