Re: Converting README documentation to Markdown

2024-12-02 Thread Peter Eisentraut
On 01.10.24 22:15, Daniel Gustafsson wrote: On 1 Oct 2024, at 16:53, Jelte Fennema-Nio wrote: On Tue, 1 Oct 2024 at 15:52, Daniel Gustafsson wrote: Apart from this, I don't changing the placeholders like to < foo >. In some cases, this really decreases readability. Maybe we should look f

Re: Converting README documentation to Markdown

2024-10-01 Thread Tristan Partin
On Sat Jun 29, 2024 at 5:24 AM EDT, Jelte Fennema-Nio wrote: On Fri, 28 Jun 2024 at 20:40, Peter Eisentraut wrote: I have my "less" set up so that "less somefile.md" automatically renders the markdown. That's been pretty useful. But if that now keeps making a mess out of PostgreSQL's README f

Re: Converting README documentation to Markdown

2024-10-01 Thread Daniel Gustafsson
> On 1 Oct 2024, at 16:53, Jelte Fennema-Nio wrote: > On Tue, 1 Oct 2024 at 15:52, Daniel Gustafsson wrote: >>> Apart from this, I don't changing the placeholders like to < foo >. >>> In some cases, this really decreases readability. Maybe we should look for >>> different approaches there.

Re: Converting README documentation to Markdown

2024-10-01 Thread Jelte Fennema-Nio
On Tue, 1 Oct 2024 at 15:52, Daniel Gustafsson wrote: > > So we need to think about a way to make this more robust for future people > > editing. Maybe something in .gitattributes or some editor settings. > > Otherwise, it will be all over the places after a while. > > Maybe we can add some fo

Re: Converting README documentation to Markdown

2024-09-23 Thread Peter Eisentraut
On 10.09.24 14:50, Daniel Gustafsson wrote: On 1 Jul 2024, at 12:22, Daniel Gustafsson wrote: Attached is a v2 which fixes a conflict, if there is no interest in Markdown I'll drop 0001 and the markdown-specifics from 0002 to instead target increased consistency. Since there doesn't seem to

Re: Converting README documentation to Markdown

2024-09-10 Thread Robert Haas
On Tue, Sep 10, 2024 at 8:51 AM Daniel Gustafsson wrote: > Since there doesn't seem to be much interest in going all the way to Markdown, Just for the record, I suspect going to Markdown is actually the right thing to do. I am personally unenthusiastic about it because I need one more thing to wo

Re: Converting README documentation to Markdown

2024-09-10 Thread Daniel Gustafsson
> On 10 Sep 2024, at 17:37, Tom Lane wrote: > > Daniel Gustafsson writes: >> Since there doesn't seem to be much interest in going all the way to >> Markdown, >> the attached 0001 is just the formatting changes for achieving (to some >> degree) >> consistency among the README's. This mostly b

Re: Converting README documentation to Markdown

2024-09-10 Thread Tom Lane
Daniel Gustafsson writes: > Since there doesn't seem to be much interest in going all the way to Markdown, > the attached 0001 is just the formatting changes for achieving (to some > degree) > consistency among the README's. This mostly boils down to using a consistent > amount of whitespace aro

Re: Converting README documentation to Markdown

2024-07-01 Thread Daniel Gustafsson
> On 28 Jun 2024, at 20:40, Peter Eisentraut wrote: > If we're going to do it, then I expect that the files are marked up correctly > at all times. I agree with that. I don't think it will be a terribly high bar though since we were pretty much already writing markdown. We already have pandoc

Re: Converting README documentation to Markdown

2024-06-29 Thread Jelte Fennema-Nio
On Fri, 28 Jun 2024 at 20:40, Peter Eisentraut wrote: > I have my "less" set up so that "less somefile.md" automatically renders > the markdown. That's been pretty useful. But if that now keeps making > a mess out of PostgreSQL's README files, then I'm going to have to keep > fixing things, and

Re: Converting README documentation to Markdown

2024-06-28 Thread Peter Eisentraut
On 28.06.24 11:56, Jelte Fennema-Nio wrote: On Fri, 28 Jun 2024 at 09:38, Peter Eisentraut wrote: Getting that right in Markdown can be quite tricky. I agree that in some cases it's tricky. But what's the worst case that can happen when you get it wrong? It renders weird on github.com. I ha

Re: Converting README documentation to Markdown

2024-06-28 Thread Tatsuo Ishii
> I've been thinking about this some more. I think the most value here > would be to just improve the plain-text formatting, so that there are > consistent list styles, header styles, indentation, some of the > ambiguities cleared up -- much of which your 0001 patch does. You > might as well be t

Re: Converting README documentation to Markdown

2024-06-28 Thread Jelte Fennema-Nio
On Fri, 28 Jun 2024 at 09:38, Peter Eisentraut wrote: > Getting that right in Markdown can be quite tricky. I agree that in some cases it's tricky. But what's the worst case that can happen when you get it wrong? It renders weird on github.com. Luckily there's a "code" button to go to the plain t

Re: Converting README documentation to Markdown

2024-06-28 Thread Peter Eisentraut
On 15.05.24 14:26, Daniel Gustafsson wrote: Another aspect of platform/flavour was to make the markdown version easy to maintain for hackers writing content. Requiring the minimum amount of markup seems like the developer-friendly way here to keep productivity as well as document quality high.

Re: Converting README documentation to Markdown

2024-05-15 Thread Daniel Gustafsson
> On 13 May 2024, at 09:20, Peter Eisentraut wrote: > I started looking through this and immediately found a bunch of tiny > problems. (This is probably in part because the READMEs under > src/backend/access/ are some of the more complicated ones, but then they are > also the ones that might

Re: Converting README documentation to Markdown

2024-05-13 Thread Peter Eisentraut
On 08.04.24 21:29, Daniel Gustafsson wrote: Over in [0] I asked whether it would be worthwhile converting all our README files to Markdown, and since it wasn't met with pitchforks I figured it would be an interesting excercise to see what it would take (my honest gut feeling was that it would be

Re: Converting README documentation to Markdown

2024-04-08 Thread Daniel Gustafsson
> On 8 Apr 2024, at 22:30, Erik Wienhold wrote: > On 2024-04-08 21:29 +0200, Daniel Gustafsson wrote: > I've only peeked at a couple of those READMEs, but they look alright so > far (at least on GitHub). Should we settle on a specific Markdown > flavor[1]? Because I'm never sure if some markups

Re: Converting README documentation to Markdown

2024-04-08 Thread Erik Wienhold
On 2024-04-08 21:29 +0200, Daniel Gustafsson wrote: > Over in [0] I asked whether it would be worthwhile converting all our README > files to Markdown, and since it wasn't met with pitchforks I figured it would > be an interesting excercise to see what it would take (my honest gut feeling > was tha