[pve-devel] [PATCH docs v2 1/5] package-repos: improve wording partly based on pmg-docs

Christoph Heiss c.heiss at proxmox.com
Mon Mar 11 13:29:07 CET 2024


Some sentences are phrased better and more expansive in pmg-docs, so
take them from there and adapt them as needed.

Rephrases some redundant parts (e.g. enterprise repo introduction) and
moves the email/changelog paragraph to the top, since that applies to
all repos.

Signed-off-by: Christoph Heiss <c.heiss at proxmox.com>
---
Changes v1 -> v2:
  * deduplicate email/changelog paragraph, move to top
  * deduplicate enterprise repo introduction sentence
  * very slightly reword some phrases

 pve-package-repos.adoc | 26 ++++++++++++++------------
 1 file changed, 14 insertions(+), 12 deletions(-)

diff --git a/pve-package-repos.adoc b/pve-package-repos.adoc
index b0c2a95..4586f70 100644
--- a/pve-package-repos.adoc
+++ b/pve-package-repos.adoc
@@ -8,6 +8,10 @@ endif::wiki[]
 {pve} uses http://en.wikipedia.org/wiki/Advanced_Packaging_Tool[APT] as its
 package management tool like any other Debian-based system.

+{pve} automatically checks for package updates on a daily basis. The `root at pam`
+user is notified via email about available updates. From the GUI, The
+'Changelog' button can be used to see more details about the selected update.
+
 Repositories in {pve}
 ~~~~~~~~~~~~~~~~~~~~~

@@ -57,21 +61,18 @@ deb http://security.debian.org/debian-security bookworm-security main contrib
 {pve} Enterprise Repository
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~

-This is the default, stable, and recommended repository, available for all {pve}
-subscription users. It contains the most stable packages and is suitable for
-production use. The `pve-enterprise` repository is enabled by default:
+This is the recommended repository and available for all {pve} subscription
+users. It contains the most stable packages and is suitable for production use.
+The `pve-enterprise` repository is enabled by default:

 .File `/etc/apt/sources.list.d/pve-enterprise.list`
 ----
 deb https://enterprise.proxmox.com/debian/pve bookworm pve-enterprise
 ----

-The `root at pam` user is notified via email about available updates. Click the
-'Changelog' button in the GUI to see more details about the selected update.
-
-You need a valid subscription key to access the `pve-enterprise` repository.
-Different support levels are available. Further details can be found at
-{pricing-url}.
+Please note that you need a valid subscription key to access the
+`pve-enterprise` repository. We offer different support levels, which you can
+find further details about at {pricing-url}.

 NOTE: You can disable this repository by commenting out the above line using a
 `#` (at the start of the line). This prevents error messages if your host does
@@ -82,9 +83,10 @@ repository in that case.
 {pve} No-Subscription Repository
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-This is the recommended repository for testing and non-production use. Its
-packages are not as heavily tested and validated. You don't need a subscription key
-to access the `pve-no-subscription` repository.
+As the name suggests, you do not need a subscription key to access
+this repository. It can be used for testing and non-production
+use. It's not recommended to use this on production servers, as these
+packages are not always as heavily tested and validated.

 We recommend to configure this repository in `/etc/apt/sources.list`.

--
2.43.1





More information about the pve-devel mailing list