[pve-devel] applied: [PATCH v3 docs 04/10] Overhaul Installation

[Thomas Lamprecht]

On 2/5/20 3:17 PM, Aaron Lauterer wrote:
> improve phrasing, align style of CLI commands
> 
> Signed-off-by: Aaron Lauterer <a.lauterer at proxmox.com>
> ---
> v2 -> v3:
> rebased on current master

applied, with followup (see below)

> 
> v1 -> v2:
> applied suggestions from oguz [0]
> 
> [0] https://pve.proxmox.com/pipermail/pve-devel/2019-September/038964.html
> 
>  pve-installation.adoc | 260 ++++++++++++++++++++----------------------
>  1 file changed, 125 insertions(+), 135 deletions(-)
> 
> diff --git a/pve-installation.adoc b/pve-installation.adoc
> index 18cd9af..2ac47b2 100644
> --- a/pve-installation.adoc
> +++ b/pve-installation.adoc
> @@ -1,5 +1,5 @@
> -Installing Proxmox VE
> -=====================
> +Installing {pve}
> +================
>  ifndef::manvolnum[]
>  :pve-toplevel:
>  endif::manvolnum[]
> @@ -7,19 +7,19 @@ ifdef::wiki[]
>  :title: Installation
>  endif::wiki[]
>  
> -{pve} is based on Debian, therefore the disk image (ISO file) provided
> -by us includes a complete Debian system ("buster" for version 6.x) as
> -well as all necessary {pve} packages.
> +{pve} is based on Debian. This is why the install disk images (ISO files)
> +provided by Proxmox include a complete Debian system (Debian 10 "buster" for
> +{pve} version 6.x) as well as all necessary {pve} packages.
>  
> -Using the installer will guide you through the setup, allowing
> -you to partition the local disk(s), apply basic system configurations
> -(e.g. timezone, language, network) and install all required packages.
> -Using the provided ISO will get you started in just a few minutes,
> -that's why we recommend this method for new and existing users.
> +The installer will guide through the setup, allowing you to partition the local
> +disk(s), apply basic system configurations (e.g. timezone, language, network)
> +and install all required packages. This process should not take more than a few
> +minutes. Installing with the provided ISO is the recommended method for new and
> +existing users.
>  
> -Alternatively, {pve} can be installed on top of an existing Debian
> -system. This option is only recommended for advanced users since
> -detailed knowledge about {pve} is necessary.
> +Alternatively, {pve} can be installed on top of an existing Debian system. This
> +option is only recommended for advanced users because detailed knowledge about
> +{pve} is required.
>  
>  ifndef::wiki[]
>  
> @@ -31,103 +31,102 @@ endif::wiki[]
>  Using the {pve} Installer
>  -------------------------
>  
> -You can download the ISO from {website}en/downloads.
> -It includes the following:
> +Download the installer ISO at {website}en/downloads. It includes the following:
>  
>  * Complete operating system (Debian Linux, 64-bit)
>  
>  * The {pve} installer, which partitions the local disk(s) with ext4,
>    ext3, xfs or ZFS and installs the operating system.
>  
> -* {pve} kernel (Linux) with LXC and KVM support
> +* {pve} kernel (Linux) with KVM and LXC support
>  
>  * Complete toolset for administering virtual machines, containers and
>    all necessary resources
>  
> -* Web based management interface for using the toolset
> +* Web-based management interface
>  
> -NOTE: During the installation process, the complete server
> -is used by default and all existing data is removed.
> +NOTE: All existing data on the server will be removed during the installation
> +process.
>  
> -Please insert the installation media (e.g. USB stick, CD-ROM) and boot
> +Please insert the installation media (e.g. USB flash drive, CD-ROM) and boot
>  from it.
>  
>  [thumbnail="screenshot/pve-grub-menu.png"]
>  
> -After choosing the correct entry (e.g. Boot from USB) the {pve} menu
> -will be displayed, you can now select one of the following options:
> +After choosing the correct entry (e.g. Boot from USB) the {pve} menu will be
> +displayed and one of the following options can be selected:
>  
> -Install Proxmox VE::
> +Install {pve}::
>  
> -Start normal installation.
> +Starts the normal installation.
>  
> -TIP: It is possible to only use the keyboard to progress through the
> -installation wizard. Buttons can be pressed by pressing down the `ALT`
> -key, combined with the underlined character from the respective Button.
> -For example, `ALT + N` to press a `Next` button.
> +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 Proxmox VE (Debug mode)::
> +Install {pve} (Debug mode)::
>  
> -Start installation in debug mode. It opens a shell console at several
> -installation steps, so that you can debug things if something goes
> -wrong. Please press `CTRL-D` to exit those debug consoles and continue
> -installation. This option is mostly for developers and not meant for
> -general use.
> +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.
> +To exit a debug console, press `CTRL-D`. This options is primarily for
> +developers and not intended for general use.

s/This options/This option/

I dropped the "for devs only" as it is a nice mode for fixing a degraded ZFS pool,
fixing a bootloader update gone wrong and some other stuff.