public inbox for pmg-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Christoph Heiss <c.heiss@proxmox.com>
To: pmg-devel@lists.proxmox.com
Subject: [pmg-devel] [PATCH docs 4/8] installation: repos: improve & align wording with pve-docs
Date: Mon,  4 Mar 2024 14:21:51 +0100	[thread overview]
Message-ID: <20240304132159.899727-5-c.heiss@proxmox.com> (raw)
In-Reply-To: <20240304132159.899727-1-c.heiss@proxmox.com>

Most of the changes are taken from pve-docs to align the exact wording
in general, as well as changing a few subtle things to improve the
overall reading flow.

The equivalent changes will be done for pve-docs too to ensure they are
really the same in the end.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
 pmg-installation.adoc | 53 +++++++++++++++++++++----------------------
 1 file changed, 26 insertions(+), 27 deletions(-)

diff --git a/pmg-installation.adoc b/pmg-installation.adoc
index ac6a9af..8cac842 100644
--- a/pmg-installation.adoc
+++ b/pmg-installation.adoc
@@ -348,10 +348,10 @@ used, ensure that the container always leases the same IP, for example, by
 reserving one with the container's network MAC address.
 
 Additionally, you can install this on top of a container-based Debian
-installation. After configuring the
-xref:pmg_package_repositories[package repositories], you need to run:
+installation.
+xref:pmg_package_repositories[After configuring the repositories], you need to
+run:
 
-[source,bash]
 ----
 apt update
 apt install proxmox-mailgateway-container
@@ -427,19 +427,19 @@ enabled by default:
 deb https://enterprise.proxmox.com/debian/pmg bookworm pmg-enterprise
 ----
 
-As soon as updates are available, the `root@pam` user is notified via
-email about the newly available packages. From the GUI, the change-log of
-each package can be viewed (if available), showing all details of the
-update. Thus, you will never miss important security fixes.
+As soon as updates are available, the `root@pam` user is notified via email
+about the newly available packages. From the GUI, the 'Changelog' button in the
+GUI can be used to see more details about the selected update.
+Thus, you will never miss important security fixes.
 
-Please note that you need a valid subscription key to access this
-repository. We offer different support levels, which you can find further
-details about at {pricing-url}.
+Please note that you need a valid subscription key to access the
+`pmg-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 you do not have a subscription key. Please configure the
-`pmg-no-subscription` repository in this case.
+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
+not have a subscription key. Please configure the `pmg-no-subscription`
+repository in that case.
 
 
 {pmg} No-Subscription Repository
@@ -469,30 +469,29 @@ deb http://download.proxmox.com/debian/pmg bookworm pmg-no-subscription
 {pmg} Test Repository
 ~~~~~~~~~~~~~~~~~~~~~
 
-Finally, there is a repository called `pmgtest`. This contains the
-latest packages, and is heavily used by developers to test new
-features. As with before, you can configure this using
-`/etc/apt/sources.list` by adding the following line:
+This repository contains the latest packages and is primarily used by developers
+to test new features. To configure it, add the following line to
+`/etc/apt/sources.list`:
 
 .sources.list entry for `pmgtest`
 ----
 deb http://download.proxmox.com/debian/pmg bookworm pmgtest
 ----
 
-WARNING: the `pmgtest` repository should only be used
-for testing new features or bug fixes.
-
+WARNING: The `pmgtest` repository should (as the name implies) only be used for
+testing new features or bug fixes.
 
 SecureApt
 ~~~~~~~~~
 
-We use GnuPG to sign the `Release` files inside these repositories,
-and APT uses these signatures to verify that all packages are from a
-trusted source.
+The 'Release' files in the repositories are signed with GnuPG. APT is using
+these signatures to verify that all packages are from a trusted source.
+
+If you install {pmg} from an official ISO image, the key for verification is
+already installed.
 
-The key used for verification is already installed, if you install from
-our installation CD. If you install via another means, you can manually
-download the key by executing the following command as root user:
+If you install {pmg} on top of Debian, download and install
+the key by executing the following commands as `root` user:
 
 ----
  # wget https://enterprise.proxmox.com/debian/proxmox-release-bookworm.gpg -O /etc/apt/trusted.gpg.d/proxmox-release-bookworm.gpg
-- 
2.43.0





  parent reply	other threads:[~2024-03-04 13:22 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-04 13:21 [pmg-devel] [PATCH docs 0/8] improve & unify installation(-related) documentation Christoph Heiss
2024-03-04 13:21 ` [pmg-devel] [PATCH docs 1/8] gitignore: add package build outputs Christoph Heiss
2024-03-04 13:21 ` [pmg-devel] [PATCH docs 2/8] getting-help: align wording with respective pve-docs page Christoph Heiss
2024-03-04 13:21 ` [pmg-devel] [PATCH docs 3/8] getting-help: add mailing lists link Christoph Heiss
2024-03-04 13:21 ` Christoph Heiss [this message]
2024-03-04 13:21 ` [pmg-devel] [PATCH docs 5/8] installation: iso: improve & align wording with pve-docs Christoph Heiss
2024-03-04 13:21 ` [pmg-devel] [PATCH docs 6/8] installation: lvm-options: " Christoph Heiss
2024-03-04 13:21 ` [pmg-devel] [PATCH docs 7/8] installation: debian: " Christoph Heiss
2024-03-04 13:21 ` [pmg-devel] [PATCH docs 8/8] installation: zfs: add advanced zfs configuration section 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=20240304132159.899727-5-c.heiss@proxmox.com \
    --to=c.heiss@proxmox.com \
    --cc=pmg-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