Re: An improved README experience for PostgreSQL

Andrew Atkinson <andyatkinson@gmail.com>

From: Andrew Atkinson <andyatkinson@gmail.com>

To: Nathan Bossart <nathandbossart@gmail.com>

Cc: Tom Lane <tgl@sss.pgh.pa.us>, "David E. Wheeler" <david@justatheory.com>, Alvaro Herrera <alvherre@alvh.no-ip.org>, Joe Conway <mail@joeconway.com>, Daniel Gustafsson <daniel@yesql.se>, PostgreSQL Hackers <pgsql-hackers@postgresql.org>, Samay Sharma <samay@tembo.io>

Date: 2024-02-28T21:43:27Z

Lists: pgsql-hackers

Commits

Same data as JSON: GET /api/v1/messages/:b64id/commits the thread's linked commits as JSON, with link sources. API reference →

Add CODE_OF_CONDUCT.md, CONTRIBUTING.md, and SECURITY.md.
- dec9d4acdb7d 18.0 landed
Revise the style of a paragraph in README.md.
- 84d80663199b 17.0 landed
Convert README to Markdown.
- 363eb059966d 17.0 landed

Looks good!

Presentation of Markdown file as HTML on mirrors I know of:
https://github.com/postgres/postgres/blob/master/README.md
https://gitlab.com/postgres/postgres/-/blob/master/README.md



On Wed, Feb 28, 2024 at 2:59 PM Nathan Bossart <nathandbossart@gmail.com>
wrote:

> On Wed, Feb 28, 2024 at 02:21:49PM -0600, Nathan Bossart wrote:
> > On Wed, Feb 28, 2024 at 02:07:34PM -0600, Andrew Atkinson wrote:
> >> I agree that starting with the direct conversion is reasonable. Markdown
> >> "modernizes" the file using a popular plain text file format that's
> >> renderable.
> >
> > Thanks.  I'll commit this shortly.
>
> Committed.
>
> --
> Nathan Bossart
> Amazon Web Services: https://aws.amazon.com
>