[pve-devel] [PATCH docs 0/9] improve & unify installation(-related) documentation

Christoph Heiss c.heiss at proxmox.com
Mon Mar 4 14:22:07 CET 2024


This series in short tries to bring the documentation for the
ISO installation flow and anything related to it in line the with
respective documentation for PMG. As both products use the same
installer (minus small differences such as LVM options and BTRFS
support) and overall same basic system setup, it is worth to unify them.

This also brings the benefit that future changes should be more easily
adaptable to both.

As this essentially takes the "best of both worlds" in tries to combine
them, an accompanying series is also provided for `pmg-docs` on the
respective mailing list - so please also take a look there.

FWIW; happy to further improve these sections if there suggestions,
since I'm already changing a lot anyway.

RFC: It might be worth to introduce some common/shared documentation
"base" for PVE & PMG? There are definitely some more things that could
be shared. E.g. the ZFS administration guide, that is also applicable
to PMG.

Christoph Heiss (9):
  gitignore: add package build outputs
  asciidoc: introduce `pricing-url` variable, much like pmg-docs
  local-btrfs: unify casing for btrfs
  getting-help: forum: align wording with pmg-docs
  package-repos: align wording with pmg-docs
  installation: iso: improve & align wording with pmg-docs
  installation: lvm-options: improve & align wording with pmg-docs
  installation: zfs-options: improve & align wording with pmg-docs
  installation: iso: reflow location and password dialog screenshots

 .gitignore                 |   3 +
 asciidoc/asciidoc-pve.conf |   1 +
 getting-help.adoc          |  10 +--
 local-btrfs.adoc           |   8 +-
 pve-installation.adoc      | 148 ++++++++++++++++++++++++-------------
 pve-package-repos.adoc     |  18 +++--
 6 files changed, 120 insertions(+), 68 deletions(-)

--
2.43.0





More information about the pve-devel mailing list