Re: An improved README experience for PostgreSQL

Nathan Bossart <nathandbossart@gmail.com>

From: Nathan Bossart <nathandbossart@gmail.com>

To: Peter Eisentraut <peter@eisentraut.org>

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

Date: 2024-03-21T14:11:30Z

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

Attachments

readme_fix.patch (text/x-diff) patch

On Thu, Mar 21, 2024 at 02:42:27PM +0100, Peter Eisentraut wrote:
> The committed README.md contains trailing whitespace on one line:
> 
>  General documentation about this version of PostgreSQL can be found at:$
> -https://www.postgresql.org/docs/devel/$
> +<https://www.postgresql.org/docs/devel/>  $
> 
> If this is intentional (it could be, since trailing whitespace is
> potentially significant in Markdown), then please add something to
> .gitattributes.  Otherwise, please fix that.

I added that to maintain the line break that was in the non-Markdown
version.  I'd rather match the style of the following paragraph (patch
attached) than mess with .gitattributes.

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