Horton

Re: An improved README experience for PostgreSQL

Nathan Bossart <nathandbossart@gmail.com>

View thread
From: Nathan Bossart <nathandbossart@gmail.com>
To: "David E. Wheeler" <david@justatheory.com>
Cc: 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-02-28T19:08:03Z
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 →

  1. Add CODE_OF_CONDUCT.md, CONTRIBUTING.md, and SECURITY.md.

  2. Revise the style of a paragraph in README.md.

  3. Convert README to Markdown.

Attachments

On Wed, Feb 28, 2024 at 01:54:59PM -0500, David E. Wheeler wrote:
> On Feb 28, 2024, at 1:51 PM, Alvaro Herrera <alvherre@alvh.no-ip.org> wrote:
>> *IF* people don't go overboard, yes.  I agree, but let's keep an eye so
>> that it doesn't become an unreadable mess.  I've seen some really
>> horrible markdown files that I'm sure most of you would object to.
> 
> Markdown++
> 
> IME the keys to decent-looking Markdown are:
> 
> 1. Wrapping lines to a legible width (76-80 chars)
> 2. Link references rather than inline links
> 
> I try to follow these for my blog; posts end up looking like this:
> 
> https://justatheory.com/2024/02/extension-metadata-typology.text
> 
> (Append `.text` to any post to see the raw(ish) Markdown.

Here is what converting the current README to Markdown with no other
content changes might look like.

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