public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Dylan Whyte <d.whyte@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH v3 pve-docs 4/4] pvenode/wake-on-lan: language fix-up
Date: Wed,  1 Sep 2021 16:16:15 +0200	[thread overview]
Message-ID: <20210901141615.1832385-4-d.whyte@proxmox.com> (raw)
In-Reply-To: <20210901141615.1832385-1-d.whyte@proxmox.com>

minor corrections to the introduction and wake-on-lan section of
"Proxmox VE Node Management"

also expand introduction, based on new content

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---

changes from v1:
* New patch. May as well do some fix-up while I'm here!

changes from v2:
* unchanged

 pvenode.adoc | 28 +++++++++++++++-------------
 1 file changed, 15 insertions(+), 13 deletions(-)

diff --git a/pvenode.adoc b/pvenode.adoc
index 1600e43..e036d93 100644
--- a/pvenode.adoc
+++ b/pvenode.adoc
@@ -24,11 +24,13 @@ ifdef::wiki[]
 endif::wiki[]
 endif::manvolnum[]
 
-The {PVE} node management tool (`pvenode`) allows to control node specific
+The {PVE} node management tool (`pvenode`) allows you to control node specific
 settings and resources.
 
-Currently `pvenode` allows to set a node's description and to manage
-the node's SSL certificates used for the API and the web GUI through `pveproxy`.
+Currently `pvenode` allows you to set a node's description, run various
+bulk operations on the node's guests, view the node's task history, and
+manage the node's SSL certificates, which are used for the API and the web GUI
+through `pveproxy`.
 
 ifdef::manvolnum[]
 include::output-format.adoc[]
@@ -43,7 +45,7 @@ Examples
 Both files need to be PEM encoded. `certificate.key` contains the private key
 and `certificate.crt` contains the whole certificate chain.
 
-.Setup ACME account and order a certificate for local node.
+.Setup ACME account and order a certificate for the local node.
 
 -----
 pvenode acme account register default mail@example.invalid
@@ -56,19 +58,19 @@ endif::manvolnum[]
 
 Wake-on-LAN
 ~~~~~~~~~~~
-Wake-on-LAN (WoL) allows to switch on a sleeping computer in the network by
-sending a magic packet. At least one NIC must support this feature and the
-respective option needs to be enabled in the computers firmware (BIOS/UEFI)
+Wake-on-LAN (WoL) allows you to switch on a sleeping computer in the network, by
+sending a magic packet. At least one NIC must support this feature, and the
+respective option needs to be enabled in the computer's firmware (BIOS/UEFI)
 configuration. The option name can vary from 'Enable Wake-on-Lan' to
-'Power On By PCIE Device', check your motherboards vendor manual, if unsure.
-`ethtool` can be used to check the WoL configuration of `<interface>` by
-running:
+'Power On By PCIE Device'; check your motherboard's vendor manual, if you're
+unsure. `ethtool` can be used to check the WoL configuration of `<interface>`
+by running:
 
 ----
 ethtool <interface> | grep Wake-on
 ----
 
-`pvenode` allows to wake sleeping members of a cluster via WoL using the
+`pvenode` allows you to wake sleeping members of a cluster via WoL, using the
 command:
 
 ----
@@ -76,8 +78,8 @@ pvenode wakeonlan <node>
 ----
 
 This broadcasts the WoL magic packet on UDP port 9, containing the MAC address
-of `<node>` obtained from the `wakeonlan` property. The node specific
-`wakeonlan` property can be set by the following command:
+of `<node>` obtained from the `wakeonlan` property. The node-specific
+`wakeonlan` property can be set using the following command:
 
 ----
 pvenode config set -wakeonlan XX:XX:XX:XX:XX:XX
-- 
2.30.2





  parent reply	other threads:[~2021-09-01 14:16 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-01 14:16 [pve-devel] [PATCH v3 pve-docs 1/4] remove pvenode.adoc from chapter 18 Dylan Whyte
2021-09-01 14:16 ` [pve-devel] [PATCH v3 pve-docs 2/4] fix #844: document first VM/CT start-up delay Dylan Whyte
2021-09-01 14:16 ` [pve-devel] [PATCH v3 pve-docs 3/4] pvenode: add task & migrate/stop/startall sections Dylan Whyte
2021-09-01 14:16 ` Dylan Whyte [this message]
2021-09-01 14:33 ` [pve-devel] applied-series: [PATCH v3 pve-docs 1/4] remove pvenode.adoc from chapter 18 Thomas Lamprecht

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=20210901141615.1832385-4-d.whyte@proxmox.com \
    --to=d.whyte@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