[pve-devel] [PATCH docs] tree-wide: properly use {pve} instead of PVE

Fabian Grünbichler f.gruenbichler at proxmox.com
Tue Mar 28 14:03:57 CEST 2023

where applicable, or expand/replace where it's not a good fit or automatic
expansion doesn't work.

there are a few more in generated files, those need to be cleaned up

Signed-off-by: Fabian Grünbichler <f.gruenbichler at proxmox.com>

    specifically, HA resources has \{pve\}, where the perl schema doesn't have the
    back slashes, so somewhere in the formatting code escaping happens when it
    shouldn't, but removing the escaping might break something else..
    pve-access-control has a few bare PVE instances in the LDAP schema, and one in
    a deprecation note "PVE-8.0" in PVE::API2::AccessControl.

 getting-help.adoc      | 4 ++--
 pmxcfs.adoc            | 4 ++--
 pve-firewall.adoc      | 2 +-
 pve-package-repos.adoc | 2 +-
 pvesm.adoc             | 2 +-
 pvesr.adoc             | 6 +++---
 6 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/getting-help.adoc b/getting-help.adoc
index 7a776b9..4b20956 100644
--- a/getting-help.adoc
+++ b/getting-help.adoc
@@ -27,13 +27,13 @@ Mailing Lists
 This is a fast way to communicate with the {pve} community via email.
 * Mailing list for users:
-  http://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-user[PVE User List]
+  http://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-user[{PVE} User List]
 {pve} is fully open source and contributions are welcome! The primary
 communication channel for developers is the:
 * Mailing list for developers:
-  http://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel[PVE development
+  http://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel[{PVE} development
diff --git a/pmxcfs.adoc b/pmxcfs.adoc
index ea15559..50654c5 100644
--- a/pmxcfs.adoc
+++ b/pmxcfs.adoc
@@ -26,7 +26,7 @@ endif::manvolnum[]
 The Proxmox Cluster file system (``pmxcfs'') is a database-driven file
 system for storing configuration files, replicated in real time to all
-cluster nodes using `corosync`. We use this to store all PVE related
+cluster nodes using `corosync`. We use this to store all {PVE} related
 configuration files.
 Although the file system stores all data inside a persistent database
@@ -106,7 +106,7 @@ Files
 |`ha/resources.cfg`                     | Resources managed by high availability, and their current state
 |`nodes/<NAME>/config`                  | Node-specific configuration
 |`nodes/<NAME>/lxc/<VMID>.conf`         | VM configuration data for LXC containers
-|`nodes/<NAME>/openvz/`                 | Prior to PVE 4.0, used for container configuration data (deprecated, removed soon)
+|`nodes/<NAME>/openvz/`                 | Prior to {pve} 4.0, used for container configuration data (deprecated, removed soon)
 |`nodes/<NAME>/pve-ssl.key`             | Private SSL key for `pve-ssl.pem`
 |`nodes/<NAME>/pve-ssl.pem`             | Public SSL certificate for web server (signed by cluster CA)
 |`nodes/<NAME>/pveproxy-ssl.key`        | Private SSL key for `pveproxy-ssl.pem` (optional)
diff --git a/pve-firewall.adoc b/pve-firewall.adoc
index 55c8804..ea5d27d 100644
--- a/pve-firewall.adoc
+++ b/pve-firewall.adoc
@@ -324,7 +324,7 @@ Standard IP set `management`
 This IP set applies only to host firewalls (not VM firewalls).  Those
-IPs are allowed to do normal management tasks (PVE GUI, VNC, SPICE,
+IPs are allowed to do normal management tasks ({PVE} GUI, VNC, SPICE,
 The local cluster network is automatically added to this IP set (alias
diff --git a/pve-package-repos.adoc b/pve-package-repos.adoc
index 52169a0..11f6690 100644
--- a/pve-package-repos.adoc
+++ b/pve-package-repos.adoc
@@ -93,7 +93,7 @@ We recommend to configure this repository in `/etc/apt/sources.list`.
 deb http://ftp.debian.org/debian bullseye main contrib
 deb http://ftp.debian.org/debian bullseye-updates main contrib
-# PVE pve-no-subscription repository provided by proxmox.com,
+# Proxmox VE pve-no-subscription repository provided by proxmox.com,
 # NOT recommended for production use
 deb http://download.proxmox.com/debian/pve bullseye pve-no-subscription
diff --git a/pvesm.adoc b/pvesm.adoc
index 6ade1a4..b131015 100644
--- a/pvesm.adoc
+++ b/pvesm.adoc
@@ -67,7 +67,7 @@ data to different nodes.
 .Available storage types
-|Description    |PVE type    |Level |Shared|Snapshots|Stable
+|Description    |Plugin type |Level |Shared|Snapshots|Stable
 |ZFS (local)    |zfspool     |file  |no    |yes      |yes
 |Directory      |dir         |file  |no    |no^1^    |yes
 |BTRFS          |btrfs       |file  |no    |yes      |technology preview
diff --git a/pvesr.adoc b/pvesr.adoc
index 1981b9c..d93e36f 100644
--- a/pvesr.adoc
+++ b/pvesr.adoc
@@ -71,10 +71,10 @@ Supported Storage Types
 .Storage Types
-|Description    |PVE type    |Snapshots|Stable
+|Description    |Plugin type |Snapshots|Stable
 |ZFS (local)    |zfspool     |yes      |yes
 Schedule Format

More information about the pve-devel mailing list