[pve-devel] [PATCH docs 00/10] docs (mostly) spelling update

[pve-devel] [PATCH docs 00/10] docs (mostly) spelling update

[Matthias Heiserer]

These are mostly about the first chapters, I'll try to look through the later ones aswell.
Many small patches, feel free to squash them, but I figured it's easier that way when the inevitable
discussions about proper spelling arise :)


Matthias Heiserer (10):
  consistently use 'web interface' (two words)
  remove misplaced comma
  consistently capitalize Ceph
  add note that secure boot needs to be disabled for host installation
  UPDATE IMAGE IN DOCSgit diff pve-installation.adocgit diff
    pve-installation.adoc! Installation options were moved into advanced
    folder, update docs to reflect that.
  add missing comma in if sentences
  rephrase when root password is set to make it clear that when logging
    it, it is already set
  add missing letter
  it's -> its because it isn't 'it is'
  update link to debian handbook. current one is 404

 certificate-management.adoc         |  2 +-
 hyper-converged-infrastructure.adoc |  6 +++---
 pve-installation.adoc               | 18 +++++++++---------
 pve-storage-pbs.adoc                |  2 +-
 pve-storage-rbd.adoc                |  4 ++--
 pveceph.adoc                        |  6 +++---
 sysadmin.adoc                       |  4 ++--
 7 files changed, 21 insertions(+), 21 deletions(-)

-- 
2.30.2

[pve-devel] [PATCH docs 01/10] consistently use 'web interface' (two words)

[Matthias Heiserer]

Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
---
 certificate-management.adoc         | 2 +-
 hyper-converged-infrastructure.adoc | 2 +-
 pve-storage-pbs.adoc                | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/certificate-management.adoc b/certificate-management.adoc
index 4fd2a8a..edf0468 100644
--- a/certificate-management.adoc
+++ b/certificate-management.adoc
@@ -33,7 +33,7 @@ the cluster CA and therefore not automatically trusted by browsers and
 operating systems.
 2. use an externally provided certificate (e.g. signed by a commercial CA).
 3. use ACME (Let's Encrypt) to get a trusted certificate with automatic
-renewal, this is also integrated in the {pve} API and Webinterface.
+renewal, this is also integrated in the {pve} API and web interface.
 
 For options 2 and 3 the file `/etc/pve/local/pveproxy-ssl.pem` (and
 `/etc/pve/local/pveproxy-ssl.key`, which needs to be without password) is used.
diff --git a/hyper-converged-infrastructure.adoc b/hyper-converged-infrastructure.adoc
index 1c1cc74..3b15093 100644
--- a/hyper-converged-infrastructure.adoc
+++ b/hyper-converged-infrastructure.adoc
@@ -46,7 +46,7 @@ Hyper-Converged Infrastructure: Storage
 
 {pve} has tightly integrated support for deploying a hyper-converged storage
 infrastructure. You can, for example, deploy and manage the following two
-storage technologies by using the Webinterface only:
+storage technologies by using the web interface only:
 
 - *ceph*: a both, self-healing and self-managing shared, reliable and highly
   scalable storage system. Checkout
diff --git a/pve-storage-pbs.adoc b/pve-storage-pbs.adoc
index 4b94ffd..1006a64 100644
--- a/pve-storage-pbs.adoc
+++ b/pve-storage-pbs.adoc
@@ -11,7 +11,7 @@ Storage pool type: `pbs`
 This backend allows direct integration of a Proxmox Backup Server into {pve}
 like any other storage.
 A Proxmox Backup storage can be added directly through the {pve} API, CLI or
-the webinterface.
+the web interface.
 
 Configuration
 ~~~~~~~~~~~~~
-- 
2.30.2

[pve-devel] [PATCH docs 02/10] remove misplaced comma

[Matthias Heiserer]

Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
---
 hyper-converged-infrastructure.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/hyper-converged-infrastructure.adoc b/hyper-converged-infrastructure.adoc
index 3b15093..ee9f185 100644
--- a/hyper-converged-infrastructure.adoc
+++ b/hyper-converged-infrastructure.adoc
@@ -48,7 +48,7 @@ Hyper-Converged Infrastructure: Storage
 infrastructure. You can, for example, deploy and manage the following two
 storage technologies by using the web interface only:
 
-- *ceph*: a both, self-healing and self-managing shared, reliable and highly
+- *ceph*: a both self-healing and self-managing shared, reliable and highly
   scalable storage system. Checkout
   xref:chapter_pveceph[how to manage ceph services on {pve} nodes]
 
-- 
2.30.2

[pve-devel] [PATCH docs 03/10] consistently capitalize Ceph

[Matthias Heiserer]

Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
---
 hyper-converged-infrastructure.adoc | 4 ++--
 pve-storage-rbd.adoc                | 4 ++--
 pveceph.adoc                        | 6 +++---
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/hyper-converged-infrastructure.adoc b/hyper-converged-infrastructure.adoc
index ee9f185..4616392 100644
--- a/hyper-converged-infrastructure.adoc
+++ b/hyper-converged-infrastructure.adoc
@@ -48,9 +48,9 @@ Hyper-Converged Infrastructure: Storage
 infrastructure. You can, for example, deploy and manage the following two
 storage technologies by using the web interface only:
 
-- *ceph*: a both self-healing and self-managing shared, reliable and highly
+- *Ceph*: a both self-healing and self-managing shared, reliable and highly
   scalable storage system. Checkout
-  xref:chapter_pveceph[how to manage ceph services on {pve} nodes]
+  xref:chapter_pveceph[how to manage Ceph services on {pve} nodes]
 
 - *ZFS*: a combined file system and logical volume manager with extensive
   protection against data corruption, various RAID modes, fast and cheap
diff --git a/pve-storage-rbd.adoc b/pve-storage-rbd.adoc
index 5f8619a..5fe558a 100644
--- a/pve-storage-rbd.adoc
+++ b/pve-storage-rbd.adoc
@@ -109,9 +109,9 @@ management, see the Ceph docs.footnoteref:[cephusermgmt,{cephdocs-url}/rados/ope
 Ceph client configuration (optional)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Connecting to an external ceph storage doesn't always allow setting
+Connecting to an external Ceph storage doesn't always allow setting
 client-specific options in the config DB on the external cluster. You can add a
-`ceph.conf` beside the ceph keyring to change the ceph client configuration for
+`ceph.conf` beside the Ceph keyring to change the Ceph client configuration for
 the storage.
 
 The ceph.conf needs to have the same name as the storage.
diff --git a/pveceph.adoc b/pveceph.adoc
index 54fb214..fdd4cf6 100644
--- a/pveceph.adoc
+++ b/pveceph.adoc
@@ -636,7 +636,7 @@ pvesm add rbd <storage-name> --pool <replicated-pool> --data-pool <ec-pool>
 ----
 
 TIP: Do not forget to add the `keyring` and `monhost` option for any external
-ceph clusters, not managed by the local {pve} cluster.
+Ceph clusters, not managed by the local {pve} cluster.
 
 Destroy Pools
 ~~~~~~~~~~~~~
@@ -761,7 +761,7 @@ ceph osd crush rule create-replicated <rule-name> <root> <failure-domain> <class
 [frame="none",grid="none", align="left", cols="30%,70%"]
 |===
 |<rule-name>|name of the rule, to connect with a pool (seen in GUI & CLI)
-|<root>|which crush root it should belong to (default ceph root "default")
+|<root>|which crush root it should belong to (default Ceph root "default")
 |<failure-domain>|at which failure-domain the objects should be distributed (usually host)
 |<class>|what type of OSD backing store to use (e.g., nvme, ssd, hdd)
 |===
@@ -943,7 +943,7 @@ servers.
 pveceph fs destroy NAME --remove-storages --remove-pools
 ----
 +
-This will automatically destroy the underlying ceph pools as well as remove
+This will automatically destroy the underlying Ceph pools as well as remove
 the storages from pve config.
 
 After these steps, the CephFS should be completely removed and if you have
-- 
2.30.2

[pve-devel] [PATCH docs 04/10] add note that secure boot needs to be disabled for host installation

[Matthias Heiserer]

Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
---
 pve-installation.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pve-installation.adoc b/pve-installation.adoc
index 74a356c..8de6ac9 100644
--- a/pve-installation.adoc
+++ b/pve-installation.adoc
@@ -60,7 +60,7 @@ Please insert the xref:installation_prepare_media[prepared installation media]
 (for example, USB flash drive or CD-ROM) and boot from it.
 
 TIP: Make sure that booting from the installation medium (for example, USB) is
-enabled in your servers firmware settings.
+enabled in your servers firmware settings and secure boot is disabled.
 
 [thumbnail="screenshot/pve-grub-menu.png"]
 
-- 
2.30.2

[pve-devel] [PATCH docs 05/10] move installation options to advanced folder

[Matthias Heiserer]

@Thomas The screenshot still shows the PVE6 menu.
Do you want to update that yourself, or should I send you the up-to-date screeshot?

Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
---
 pve-installation.adoc | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/pve-installation.adoc b/pve-installation.adoc
index 8de6ac9..c86b620 100644
--- a/pve-installation.adoc
+++ b/pve-installation.adoc
@@ -75,7 +75,7 @@ TIP: It's possible to use the installation wizard with a keyboard only. Buttons
 can be clicked by pressing the `ALT` key combined with the underlined character
 from the respective button. For example, `ALT + N` to press a `Next` button.
 
-Install {pve} (Debug mode)::
+Advanced Options: Install {pve} (Debug mode)::
 
 Starts the installation in debug mode. A console will be opened at several
 installation steps. This helps to debug the situation if something goes wrong.
@@ -84,7 +84,7 @@ system with all basic tools available. You can use it, for example, to
 xref:chapter_zfs[repair a degraded ZFS 'rpool'] or fix the
 xref:sysboot[bootloader] for an existing {pve} setup.
 
-Rescue Boot::
+Advanced Options: Rescue Boot::
 
 With this option you can boot an existing installation. It searches all attached
 hard disks. If it finds an existing installation, it boots directly into that
@@ -92,7 +92,7 @@ disk using the Linux kernel from the ISO. This can be useful if there are
 problems with the boot block (grub) or the BIOS is unable to read the boot block
 from the disk.
 
-Test Memory::
+Advanced Options: Test Memory::
 
 Runs `memtest86+`. This is useful to check if the memory is functional and free
 of errors.
-- 
2.30.2

[pve-devel] [PATCH docs 06/10] add missing comma in if sentences

[Matthias Heiserer]

Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
---
 pve-installation.adoc | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/pve-installation.adoc b/pve-installation.adoc
index c86b620..e101ed3 100644
--- a/pve-installation.adoc
+++ b/pve-installation.adoc
@@ -161,10 +161,10 @@ the installation medium and restart your system.
 
 [thumbnail="screenshot/pve-install-summary.png"]
 
-If the installation failed check out specific errors on the second TTY
-(`CTRL + ALT + F2'), ensure that the systems meets the
+If the installation failed, check out specific errors on the second TTY
+(`CTRL + ALT + F2') and ensure that the systems meets the
 xref:install_minimal_requirements[minimum requirements]. If the installation
-is still not working look at the xref:getting_help[how to get help chapter].
+is still not working, look at the xref:getting_help[how to get help chapter].
 
 Further configuration is done via the Proxmox web interface. Point your browser
 to the IP address given during installation (https://youripaddress:8006).
-- 
2.30.2

[pve-devel] [PATCH docs 07/10] rephrase when root password is set to make it clear that when logging it, it is already set

[Matthias Heiserer]

Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
---
 pve-installation.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pve-installation.adoc b/pve-installation.adoc
index e101ed3..6eb84a8 100644
--- a/pve-installation.adoc
+++ b/pve-installation.adoc
@@ -169,7 +169,7 @@ is still not working, look at the xref:getting_help[how to get help chapter].
 Further configuration is done via the Proxmox web interface. Point your browser
 to the IP address given during installation (https://youripaddress:8006).
 
-NOTE: Default login is "root" (realm 'PAM') and the root password is defined
+NOTE: Default login is "root" (realm 'PAM') and the root password was defined
 during the installation process.
 
 [[advanced_lvm_options]]
-- 
2.30.2

[pve-devel] [PATCH docs 08/10] add missing letter

[Matthias Heiserer]

Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
---
 pve-installation.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pve-installation.adoc b/pve-installation.adoc
index 6eb84a8..15b6c6d 100644
--- a/pve-installation.adoc
+++ b/pve-installation.adoc
@@ -278,7 +278,7 @@ ifndef::wiki[]
 Install {pve} on Debian
 -----------------------
 
-{pve} ships as a set of Debian packages and can be installed on to of a standard
+{pve} ships as a set of Debian packages and can be installed on top of a standard
 Debian installation.
 xref:sysadmin_package_repositories[After configuring the repositories] you need
 to run the following commands:
-- 
2.30.2

[pve-devel] [PATCH docs 09/10] it's -> its because it isn't 'it is'

[Matthias Heiserer]

Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
---
 sysadmin.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sysadmin.adoc b/sysadmin.adoc
index 8ac39e1..88c3810 100644
--- a/sysadmin.adoc
+++ b/sysadmin.adoc
@@ -11,7 +11,7 @@ The following sections will focus on common virtualization tasks and explain the
 {pve} is based on https://www.debian.org/[Debian GNU/Linux] with additional
 repositories to provide the {pve} related packages. This means that the full
 range of Debian packages is available including security updates and bug fixes.
-{pve} provides it's own Linux kernel based on the Ubuntu kernel. It has all the
+{pve} provides its own Linux kernel based on the Ubuntu kernel. It has all the
 necessary virtualization and container features enabled and includes
 https://zfsonlinux.org[ZFS] and several extra hardware drivers.
 
-- 
2.30.2

[pve-devel] [PATCH docs 10/10] update link to debian handbook. current one is 404

[Matthias Heiserer]

Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
---
 sysadmin.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sysadmin.adoc b/sysadmin.adoc
index 88c3810..d3de40a 100644
--- a/sysadmin.adoc
+++ b/sysadmin.adoc
@@ -17,7 +17,7 @@ https://zfsonlinux.org[ZFS] and several extra hardware drivers.
 
 For other topics not included in the following sections, please refer to the
 Debian documentation. The
-https://debian-handbook.info/download/stable/debian-handbook.pdf[Debian
+https://debian-handbook.info/get[Debian
 Administrator\'s Handbook] is available online, and provides a comprehensive
 introduction to the Debian operating system (see xref:Hertzog13[]).
 
-- 
2.30.2

Re: [pve-devel] [PATCH docs 05/10] move installation options to advanced folder

[Thomas Lamprecht]

Am 09/11/2022 um 12:58 schrieb Matthias Heiserer:
> @Thomas The screenshot still shows the PVE6 menu.
> Do you want to update that yourself, or should I send you the up-to-date screeshot?

please place such meta question/info not in the commit message itself but..

> Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
> ---

-> here, where it's visible on review but ignored by git.

Anyhow, I'll look into updating those myself for the upcoming point release,
thx for pointing out tough (and you may remember me if I forget, while not
critical its nice to have it in sync)

[pve-devel] applied-series: [PATCH docs 00/10] docs (mostly) spelling update

[Thomas Lamprecht]

Am 09/11/2022 um 12:58 schrieb Matthias Heiserer:
> These are mostly about the first chapters, I'll try to look through the later ones aswell.
> Many small patches, feel free to squash them, but I figured it's easier that way when the inevitable
> discussions about proper spelling arise :)
> 
> 
> Matthias Heiserer (10):
>   consistently use 'web interface' (two words)
>   remove misplaced comma
>   consistently capitalize Ceph
>   add note that secure boot needs to be disabled for host installation
>   UPDATE IMAGE IN DOCSgit diff pve-installation.adocgit diff
>     pve-installation.adoc! Installation options were moved into advanced
>     folder, update docs to reflect that.
>   add missing comma in if sentences
>   rephrase when root password is set to make it clear that when logging
>     it, it is already set
>   add missing letter
>   it's -> its because it isn't 'it is'
>   update link to debian handbook. current one is 404
> 
>  certificate-management.adoc         |  2 +-
>  hyper-converged-infrastructure.adoc |  6 +++---
>  pve-installation.adoc               | 18 +++++++++---------
>  pve-storage-pbs.adoc                |  2 +-
>  pve-storage-rbd.adoc                |  4 ++--
>  pveceph.adoc                        |  6 +++---
>  sysadmin.adoc                       |  4 ++--
>  7 files changed, 21 insertions(+), 21 deletions(-)
> 


applied series, thanks!

Note that I squashed two patches and reworded a few commit messages
slightly. Most of how you separated the series was pretty good (e.g., some
tree wide change for consistent Ceph spelling makes sense in one patch) but
I think in general you might want to have simple, obvious typo fixes (i.e.,
no big rewordings) from the same chapter squashed into a single patch and
prefix the commit subject with the chapter/topic (like "installation:" or
"ceph:") but at least squashing is really quickly done from my side (and
always simpler than splitting up again), so I didn't mind about how you did
the separation, just noting that I don't expected/want every single specific
typo in its own patch.