From: Dylan Whyte <d.whyte@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH pbs-docs] docs: fix formatting; improve grammar and wording
Date: Thu, 23 Jul 2020 12:17:12 +0200 [thread overview]
Message-ID: <20200723101712.23358-1-d.whyte@proxmox.com> (raw)
Formatting: local-zfs.rst:
Add all paragraphs with "IMPORTANT:" prefix to highlighted block.
Replace {pve} with Proxmox VE.
Fix minor grammatical errors.
Reword one sentence for improved readability.
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
docs/local-zfs.rst | 20 ++++++++++----------
docs/pxar/description.rst | 2 +-
docs/sysadmin.rst | 2 +-
3 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/docs/local-zfs.rst b/docs/local-zfs.rst
index eeb98f7b..d3f0fe88 100644
--- a/docs/local-zfs.rst
+++ b/docs/local-zfs.rst
@@ -40,10 +40,9 @@ If you use a dedicated cache and/or log disk, you should use an
enterprise class SSD (e.g. Intel SSD DC S3700 Series). This can
increase the overall performance significantly.
-IMPORTANT: Do not use ZFS on top of hardware controller which has its
-own cache management. ZFS needs to directly communicate with disks. An
-HBA adapter is the way to go, or something like LSI controller flashed
-in ``IT`` mode.
+.. IMPORTANT:: Do not use ZFS on top of a hardware controller which has its own
+ cache management. ZFS needs to communicate directly with disks. An HBA adapter
+ or an LSI controller flashed in ``IT`` mode are better options.
ZFS Administration
@@ -144,8 +143,8 @@ As `<device>` it is possible to use more devices, like it's shown in
Add cache and log to an existing pool
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-If you have a pool without cache and log. First partition the SSD in
-2 partition with `parted` or `gdisk`
+If you have a pool without cache and log. First partition the SSD into
+2 partitions with `parted` or `gdisk`
.. important:: Always use GPT partition tables.
@@ -192,7 +191,7 @@ With `systemd-boot`:
# pve-efiboot-tool init <new disk's ESP>
.. NOTE:: `ESP` stands for EFI System Partition, which is setup as partition #2 on
- bootable disks setup by the {pve} installer since version 5.4. For details, see
+ bootable disks setup by the Proxmox VE installer since version 5.4. For details, see
xref:sysboot_systemd_boot_setup[Setting up a new partition for use as synced ESP].
With `grub`:
@@ -227,8 +226,8 @@ favourite editor, and uncomment the `ZED_EMAIL_ADDR` setting:
Please note Proxmox Backup forwards mails to `root` to the email address
configured for the root user.
-IMPORTANT: The only setting that is required is `ZED_EMAIL_ADDR`. All
-other settings are optional.
+.. IMPORTANT:: The only setting that is required is `ZED_EMAIL_ADDR`. All other
+ settings are optional.
Limit ZFS Memory Usage
^^^^^^^^^^^^^^^^^^^^^^
@@ -244,7 +243,8 @@ host. Use your preferred editor to change the configuration in
This example setting limits the usage to 8GB.
-.. IMPORTANT:: If your root file system is ZFS you must update your initramfs every time this value changes:
+.. IMPORTANT:: If your root file system is ZFS, you must update your initramfs
+ every time this value changes:
.. code-block:: console
diff --git a/docs/pxar/description.rst b/docs/pxar/description.rst
index ad8bd400..82b15fd9 100644
--- a/docs/pxar/description.rst
+++ b/docs/pxar/description.rst
@@ -9,7 +9,7 @@ which caters to a similar use-case.
The ``.pxar`` format is adapted to fulfill the specific needs of the Proxmox
Backup Server, for example, efficient storage of hardlinks.
The format is designed to reduce storage space needed on the server by achieving
-a high level of de-duplication.
+a high level of deduplication.
Creating an Archive
^^^^^^^^^^^^^^^^^^^
diff --git a/docs/sysadmin.rst b/docs/sysadmin.rst
index 9c564f03..c6ebe47a 100644
--- a/docs/sysadmin.rst
+++ b/docs/sysadmin.rst
@@ -14,7 +14,7 @@ repository to roll out all Proxmox related packages. This includes
updates to some Debian packages when necessary.
We also deliver a specially optimized Linux kernel, where we enable
-all required virtualization and container features. That kernel
+all required virtualization and container features. This kernel
includes drivers for ZFS_, and several hardware drivers. For example,
we ship Intel network card drivers to support their newest hardware.
--
2.20.1
reply other threads:[~2020-07-23 10:17 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20200723101712.23358-1-d.whyte@proxmox.com \
--to=d.whyte@proxmox.com \
--cc=pbs-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