| From: | Daniel Gustafsson <daniel(at)yesql(dot)se> |
|---|---|
| To: | pgsql-docs(at)lists(dot)postgresql(dot)org |
| Subject: | Good beginner doc-hacking task: clear-text vs. cleartext vs. clear text vs. plaintext etc.. |
| Date: | 2026-11-06 13:41:38 |
| Message-ID: | D7B95A7B-88B8-43E6-9DFB-2261B0849337@yesql.se |
| Views: | Whole Thread | Raw Message | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-docs |
While working on a docs patch I realized that we use a wide variety of
terminology for secrets that will not be encrypted, which is very different
from secrets which will be encrypted; the former is IMO cleartext and the
latter plaintext.
In the documentation, when we talk about secrets used for passwords
authentication and similar, we use a mix of "clear-text", "cleartext" and
"clear text"; in at least one place we also use "plaintext". There are several
cases where we use "plaintext password" correctly, but we also have the variant
"plain text" vs, "plain-text" vs. "plaintext" there as well.
It would be nice to get that cleaned up and consistent, but I don't intend to
spend time on it myself. However, I know from attending a session on
documentation at PGConf.EU that there are several potential contributors who
would like to work on the docs but don't know exactly where to start, so I
figured I'd raise it here as a good introductory project.
If someone does take a stab at it, I will of course spend the time to review
it.
--
Daniel Gustafsson
| From | Date | Subject | |
|---|---|---|---|
| Next Message | Karen Jex | 2026-11-06 14:44:41 | Re: Good beginner doc-hacking task: clear-text vs. cleartext vs. clear text vs. plaintext etc.. |
| Previous Message | Arvind Kandpal | 2026-11-05 07:31:15 | Re: 4.1.4. Special Characters |