[pve-devel] [PATCH pmg-docs; pmg-docs; proxmox-backup/docs 0/8] fix consistency of some words

Noel Ullreich n.ullreich at proxmox.com
Tue Jun 27 14:40:02 CEST 2023


In the docs for pve, pmg, and pbs, the consistency and grammatical
correctnes of some common words was not always good.
I fixed the words:
* USB flash drive
* command line/command-line/commandline
* motherboard/mainboard/main board
* passhrough/pass-through

Really, these are just some quick ones I found that (imo) were easy and
necessary to fix, and, if possible, this should be automated somehow.
Dietmar and I talked about this off-list and brainstormed some ideas,
but nothing concrete so far.

I also added some tables in our internal writing style guide, perhaps
this should be made public? For those, that are interested in writing
docs for pve/pbs/pmg?

Noel Ullreich (4):
  consistency of passthrough/pass-through
  consistency: change mainboard to motherboard
  consistenct of USB flash drive spelling
  Fixed spelling of command line/command-line

 certificate-management.adoc  |  2 +-
 ha-manager.adoc              | 10 +++++-----
 index.adoc                   |  2 +-
 pct.adoc                     | 10 +++++-----
 pve-admin-guide.adoc         |  4 ++--
 pve-faq.adoc                 |  2 +-
 pve-firewall.adoc            |  2 +-
 pve-installation-media.adoc  |  2 +-
 pve-intro.adoc               |  6 +++---
 pve-storage-lvmthin.adoc     |  2 +-
 pve-storage-pbs.adoc         |  2 +-
 pve-system-requirements.adoc |  2 +-
 pveceph.adoc                 |  6 +++---
 pvecm.adoc                   |  4 ++--
 pvesm.adoc                   |  4 ++--
 pvesr.adoc                   |  6 +++---
 pveum.adoc                   | 10 +++++-----
 qm-pci-passthrough.adoc      |  2 +-
 qm.adoc                      | 10 +++++-----
 qm.conf.5-opts.adoc          | 10 +++++-----
 vzdump.adoc                  |  2 +-
 21 files changed, 50 insertions(+), 50 deletions(-)

 Noel Ullreich (2):
  consistenct of USB flash drive spelling
  Fixed spelling of command line/command-line

 pmg-admin-guide.adoc        | 4 ++--
 pmg-administration.adoc     | 2 +-
 pmg-installation-media.adoc | 2 +-
 pmg-intro.adoc              | 4 ++--
 pmg-ssl-certificate.adoc    | 6 +++---
 pmgbackup.adoc              | 4 ++--
 pmgcm.adoc                  | 6 +++---
 pmgconfig.adoc              | 4 ++--
 pmgperf.adoc                | 2 +-
 9 files changed, 17 insertions(+), 17 deletions(-)

Noel Ullreich (2):
  consistenct of USB flash drive spelling
  Fixed spelling of command line/command-line

 docs/backup-client.rst                    | 8 ++++----
 docs/certificate-management.rst           | 8 ++++----
 docs/command-line-tools.rst               | 2 +-
 docs/command-syntax.rst                   | 2 +-
 docs/introduction.rst                     | 2 +-
 docs/network-management.rst               | 4 ++--
 docs/package-repositories.rst             | 2 +-
 docs/proxmox-file-restore/description.rst | 2 +-
 docs/pve-integration.rst                  | 2 +-
 docs/pxar-tool.rst                        | 2 +-
 docs/pxar/description.rst                 | 2 +-
 docs/tape-backup.rst                      | 8 ++++----
 docs/technical-overview.rst               | 2 +-
 docs/user-management.rst                  | 2 +-
 14 files changed, 24 insertions(+), 24 deletions(-)
-- 
2.39.2






More information about the pve-devel mailing list