public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Christoph Heiss <c.heiss@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [RFC PATCH docs-common 04/13] partials: installation-flow: adapt from pve-docs
Date: Fri, 19 Apr 2024 11:05:10 +0200	[thread overview]
Message-ID: <20240419090519.291775-5-c.heiss@proxmox.com> (raw)
In-Reply-To: <20240419090519.291775-1-c.heiss@proxmox.com>

A trivial s/{pve}/{product}/g again and a additional
s/screenshot\/pve-/screenshot\//g to fix the screenshot paths.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
 partials/installation-flow.adoc | 47 +++++++++++++++++----------------
 1 file changed, 24 insertions(+), 23 deletions(-)

diff --git a/partials/installation-flow.adoc b/partials/installation-flow.adoc
index b796676..9a7d1b3 100644
--- a/partials/installation-flow.adoc
+++ b/partials/installation-flow.adoc
@@ -7,14 +7,14 @@ Please insert the xref:installation_prepare_media[prepared installation media]

 TIP: Make sure that booting from the installation medium (for example, USB) is
 enabled in your server's firmware settings. Secure boot needs to be disabled
-when booting an installer prior to {pve} version 8.1.
+when booting an installer prior to {product} version 8.1.

-[thumbnail="screenshot/pve-grub-menu.png"]
+[thumbnail="screenshot/grub-menu.png"]

-After choosing the correct entry (for example, 'Boot from USB') the {pve} menu
-will be displayed, and one of the following options can be selected:
+After choosing the correct entry (for example, 'Boot from USB') the {product}
+menu will be displayed, and one of the following options can be selected:

-Install {pve} (Graphical)::
+Install {product} (Graphical)::

 Starts the normal installation.

@@ -22,20 +22,20 @@ 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} (Terminal UI)::
+Install {product} (Terminal UI)::

 Starts the terminal-mode installation wizard. It provides the same overall
 installation experience as the graphical installer, but has generally better
 compatibility with very old and very new hardware.

-Install {pve} (Terminal UI, Serial Console)::
+Install {product} (Terminal UI, Serial Console)::

 Starts the terminal-mode installation wizard, additionally setting up the Linux
 kernel to use the (first) serial port of the machine for in- and output. This
 can be used if the machine is completely headless and only has a serial console
 available.

-[thumbnail="screenshot/pve-tui-installer.png"]
+[thumbnail="screenshot/tui-installer.png"]

 Both modes use the same code base for the actual installation process to
 benefit from more than a decade of bug fixes and ensure feature parity.
@@ -44,21 +44,21 @@ TIP: The 'Terminal UI' option can be used in case the graphical installer does
 not work correctly, due to e.g. driver issues. See also
 xref:nomodeset_kernel_param[adding the `nomodeset` kernel parameter].

-Advanced Options: Install {pve} (Graphical, Debug Mode)::
+Advanced Options: Install {product} (Graphical, 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.
 To exit a debug console, press `CTRL-D`. This option can be used to boot a live
 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.
+xref:sysboot[bootloader] for an existing {product} setup.

-Advanced Options: Install {pve} (Terminal UI, Debug Mode)::
+Advanced Options: Install {product} (Terminal UI, Debug Mode)::

 Same as the graphical debug mode, but preparing the system to run the
 terminal-based installer instead.

-Advanced Options: Install {pve} (Serial Console Debug Mode)::
+Advanced Options: Install {product} (Serial Console Debug Mode)::

 Same the terminal-based debug mode, but additionally sets up the Linux kernel to
 use the (first) serial port of the machine for in- and output.
@@ -77,9 +77,9 @@ Runs `memtest86+`. This is useful to check if the memory is functional and free
 of errors. Secure Boot must be turned off in the UEFI firmware setup utility to
 run this option.

-You normally select *Install {pve} (Graphical)* to start the installation.
+You normally select *Install {product} (Graphical)* to start the installation.

-[thumbnail="screenshot/pve-select-target-disk.png"]
+[thumbnail="screenshot/select-target-disk.png"]

 The first step is to read our EULA (End User License Agreement). Following this,
 you can select the target hard disk(s) for the installation.
@@ -93,15 +93,16 @@ defaults to `ext4`. The installer uses LVM if you select
 `ext4` or `xfs` as a file system, and offers additional options to
 restrict LVM space (see xref:advanced_lvm_options[below]).

-{pve} can also be installed on ZFS. As ZFS offers several software RAID levels,
-this is an option for systems that don't have a hardware RAID controller. The
-target disks must be selected in the `Options` dialog. More ZFS specific
-settings can be changed under xref:advanced_zfs_options[`Advanced Options`].
+{product} can also be installed on ZFS. As ZFS offers several software RAID
+levels, this is an option for systems that don't have a hardware RAID
+controller. The target disks must be selected in the `Options` dialog. More ZFS
+specific settings can be changed under
+xref:advanced_zfs_options[`Advanced Options`].

 WARNING: ZFS on top of any hardware RAID is not supported and can result in data
 loss.

-[thumbnail="screenshot/pve-select-location.png"]
+[thumbnail="screenshot/select-location.png"]

 The next page asks for basic configuration options like your location, time
 zone, and keyboard layout. The location is used to select a nearby download
@@ -110,7 +111,7 @@ to auto-detect these settings, so you only need to change them in rare
 situations when auto-detection fails, or when you want to use a keyboard layout
 not commonly used in your country.

-[thumbnail="screenshot/pve-set-password.png", float="left"]
+[thumbnail="screenshot/set-password.png", float="left"]

 Next the password of the superuser (`root`) and an email address needs to be
 specified. The password must consist of at least 5 characters. It's highly
@@ -132,7 +133,7 @@ For example:

 - Error messages from periodic 'cron' jobs.

-[thumbnail="screenshot/pve-setup-network.png"]
+[thumbnail="screenshot/setup-network.png"]

 All those notification mails will be sent to the specified email address.

@@ -142,7 +143,7 @@ that during installation you can either specify an IPv4 or IPv6 address, but not
 both. To configure a dual stack node, add additional IP addresses after the
 installation.

-[thumbnail="screenshot/pve-installation.png", float="left"]
+[thumbnail="screenshot/installation.png", float="left"]

 The next step shows a summary of the previously selected options. Please
 re-check every setting and use the `Previous` button if a setting needs to be
@@ -152,7 +153,7 @@ After clicking `Install`, the installer will begin to format the disks and copy
 packages to the target disk(s). Please wait until this step has finished; then
 remove the installation medium and restart your system.

-[thumbnail="screenshot/pve-install-summary.png"]
+[thumbnail="screenshot/install-summary.png"]

 Copying the packages usually takes several minutes, mostly depending on the
 speed of the installation medium and the target disk performance.
--
2.44.0



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


  parent reply	other threads:[~2024-04-19  9:06 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-19  9:05 [pve-devel] [RFC PATCH docs{, -common} 0/13] introduce common documentation base Christoph Heiss
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs-common 01/13] installation-media: move page from pve-docs here Christoph Heiss
2024-04-19 10:51   ` Aaron Lauterer
2024-04-19 11:20     ` Christoph Heiss
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs-common 02/13] installation-media: adapt for common usage Christoph Heiss
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs-common 03/13] partials: add installation flow from pve-docs Christoph Heiss
2024-04-19  9:05 ` Christoph Heiss [this message]
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs-common 05/13] partials: add advanced installation hints " Christoph Heiss
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs-common 06/13] partials: advanced-installation: adapt " Christoph Heiss
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs 07/13] gitmodules: add proxmox-docs-common Christoph Heiss
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs 08/13] scan-adoc-refs: enable building pages from proxmox-docs-common/ subdir Christoph Heiss
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs 09/13] images: strip `pve-` prefix from screenshots used in common docs Christoph Heiss
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs 10/13] asciidoc: conf: add iso-url variable Christoph Heiss
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs 11/13] installation-media: move to common docs Christoph Heiss
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs 12/13] installation: use new 'installation-flow' partial from " Christoph Heiss
2024-04-19  9:05 ` [pve-devel] [RFC PATCH docs 13/13] installation: use new 'advanced-installation' " Christoph Heiss

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240419090519.291775-5-c.heiss@proxmox.com \
    --to=c.heiss@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal