Re: Add A Glossary
Alvaro Herrera <alvherre@2ndquadrant.com>
From: Alvaro Herrera <alvherre@2ndquadrant.com>
To: Corey Huinker <corey.huinker@gmail.com>
Cc: Jürgen Purtz <juergen@purtz.de>, Roger Harkavy <rogerharkavy@gmail.com>, pgsql-hackers@postgresql.org, Fabien COELHO <coelho@cri.ensmp.fr>, Michael Paquier <michael@paquier.xyz>
Date: 2020-03-20T17:51:44Z
Lists: pgsql-hackers, pgsql-docs
Attachments
- glossary-3.patch (text/x-diff) patch
On 2020-Mar-20, Corey Huinker wrote: > > Jürgen mentioned off-list that the man page doesn't build. I was going to > > look into that, but if anyone has more familiarity with that, I'm listening. > Looking at this some more, I'm not sure anything needs to be done for man > pages. Yeah, I don't think he was saying that we needed to do anything to produce a glossary man page; rather that the "make man" command failed. I tried it here, and indeed it failed. But on further investigation, after a "make maintainer-clean" it no longer failed. I'm not sure what to make of it, but it seems that this patch needn't concern itself with that. I gave a read through the first few actual definitions. It's a much slower work than I thought! Attached you'll find the first few edits that I propose. Looking at the definition of "Aggregate" it seemed weird to have it stand as a verb infinitive. I looked up other glossaries, found this one https://www.gartner.com/en/information-technology/glossary?glossaryletter=T and realized that when they do verbs, they put the present participle (-ing) form. So I changed it to "Aggregating", and split out the "Aggregate function" into its own term. In Atomic, there seemed to be excessive use of <glossterm> in the definitions. Style guides seem to suggest to do that only the first time you use a term in a definition. I removed some markup. I'm not sure about some terms such as "analytic" and "backend server". I put them in XML comments for now. The other changes should be self-explanatory. It's hard to review work from a professional tech writer. I'm under the constant impression that I'm ruining somebody's perfect end product, making a fool of myself. -- Álvaro Herrera https://www.2ndQuadrant.com/ PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services
Commits
-
Glossary: Add term "base backup"
- 606c3845988d 14.0 landed
-
Minor glossary tweaks
- a0b2d583db9f 14.0 landed
- ac25e7b039d5 13.0 landed
-
Adjust some glossary terms
- 91a890bd7fef 13.0 landed
- 816cbb59e300 14.0 landed
-
Fix more typos and grammar problems in the glossary
- eeba6c7e4366 13.0 landed
-
Review of the glossary
- 756abe2bc760 13.0 landed
-
Add a glossary to the documentation
- 347d2b07fcc2 13.0 landed