From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 17188656C8 for ; Thu, 23 Jul 2020 12:21:11 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 050D42809C for ; Thu, 23 Jul 2020 12:20:41 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id B80D528092 for ; Thu, 23 Jul 2020 12:20:39 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 7B6D943325 for ; Thu, 23 Jul 2020 12:20:39 +0200 (CEST) Date: Thu, 23 Jul 2020 12:20:08 +0200 (CEST) From: Dylan Whyte To: Proxmox Backup Server development discussion Message-ID: <1234290008.433.1595499608566@webmail.proxmox.com> In-Reply-To: <20200723101308.22429-1-d.whyte@proxmox.com> References: <20200723101308.22429-1-d.whyte@proxmox.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-Priority: 3 Importance: Normal X-Mailer: Open-Xchange Mailer v7.10.3-Rev17 X-Originating-Client: open-xchange-appsuite X-SPAM-LEVEL: Spam detection results: 0 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: Re: [pbs-devel] [PATCH pbs-docs 1/3] docs: admin guide: fix grammatical errors and improve English X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 23 Jul 2020 10:21:11 -0000 Please disregard! This is from a previously submitted patch and was resent = in error! Dylan > On 23.07.2020 12:13 Dylan Whyte wrote: >=20 > =20 > Mostly fixed typos and grammatical errors. > Improved wording in some sections, to make instructions/advice clearer. >=20 > Signed-off-by: Dylan Whyte > --- > docs/administration-guide.rst | 40 +++++++++++++++++------------------ > 1 file changed, 20 insertions(+), 20 deletions(-) >=20 > diff --git a/docs/administration-guide.rst b/docs/administration-guide.rs= t > index 1f329f80..0637df2d 100644 > --- a/docs/administration-guide.rst > +++ b/docs/administration-guide.rst > @@ -148,7 +148,7 @@ You can configure multiple datastores. Minimum one da= tastore needs to be > configured. The datastore is identified by a simple `name` and points to= a > directory on the filesystem. Each datastore also has associated retentio= n > settings of how many backup snapshots for each interval of ``hourly``, > -``daily``, ``weekly``, ``monthly``, ``yearly`` as well as an time indepe= ndent > +``daily``, ``weekly``, ``monthly``, ``yearly`` as well as a time-indepen= dent > number of backups to keep in that store. :ref:`Pruning ` and > :ref:`garbage collection ` can also be configured to= run > periodically based on a configured :term:`schedule` per datastore. > @@ -372,20 +372,20 @@ following roles exist: > :term:`Remote` > ~~~~~~~~~~~~~~ > =20 > -A remote is a different Proxmox Backup Server installation and a user on= that > +A remote refers to a separate Proxmox Backup Server installation and a u= ser on that > installation, from which you can `sync` datastores to a local datastore = with a > `Sync Job`. > =20 > -For adding a remote you need its hostname or ip, a userid and password o= n the > -remote and its certificate fingerprint to add it. To get the fingerprint= use > -the ``proxmox-backup-manager cert info`` command on the remote. > +To add a remote, you need its hostname or ip, a userid and password on t= he > +remote, and its certificate fingerprint. To get the fingerprint, use the > +``proxmox-backup-manager cert info`` command on the remote. > =20 > .. code-block:: console > =20 > # proxmox-backup-manager cert info |grep Fingerprint > Fingerprint (sha256): 64:d3:ff:3a:50:38:53:5a:9b:f7:50:...:ab:fe > =20 > -With the needed information add the remote with: > +Using the information specified above, add the remote with: > =20 > .. code-block:: console > =20 > @@ -599,12 +599,12 @@ not contained within the brackets. It is also possi= ble to specify ranges with tw > characters separated by ``-``. For example, ``[a-z]`` matches any lowerc= ase > alphabetic character and ``[0-9]`` matches any one single digit. > =20 > -The order of the glob match patterns defines if a file is included or > -excluded, later entries win over previous ones. > +The order of the glob match patterns defines whether a file is included = or > +excluded, that is to say later entries override previous ones. > This is also true for match patterns encountered deeper down the directo= ry tree, > which can override a previous exclusion. > Be aware that excluded directories will **not** be read by the backup cl= ient. > -A ``.pxarexclude`` file in a subdirectory will have no effect. > +Thus, a ``.pxarexclude`` file in an excluded subdirectory will have no e= ffect. > ``.pxarexclude`` files are treated as regular files and will be included= in the > backup archive. > =20 > @@ -656,8 +656,8 @@ Restoring this backup will result in: > Encryption > ^^^^^^^^^^ > =20 > -Proxmox backup supports client side encryption with AES-256 in GCM_ > -mode. First you need to create an encryption key: > +Proxmox Backup supports client-side encryption with AES-256 in GCM_ > +mode. To set this up, you first need to create an encryption key: > =20 > .. code-block:: console > =20 > @@ -689,13 +689,13 @@ variables ``PBS_PASSWORD`` and ``PBS_ENCRYPTION_PAS= SWORD``. > Restoring Data > ~~~~~~~~~~~~~~ > =20 > -The regular creation of backups is a necessary step to avoid data > -loss. More important, however, is the restoration. It is good practice t= o perform > +The regular creation of backups is a necessary step to avoiding data > +loss. More importantly, however, is the restoration. It is good practice= to perform > periodic recovery tests to ensure that you can access the data in > case of problems. > =20 > First, you need to find the snapshot which you want to restore. The snap= shot > -command gives a list of all snapshots on the server: > +command provides a list of all the snapshots on the server: > =20 > .. code-block:: console > =20 > @@ -727,8 +727,8 @@ backup. > =20 > # proxmox-backup-client restore host/elsa/2019-12-03T09:35:01Z root.px= ar /target/path/ > =20 > -To get the contents of any archive you can restore the ``=C3=ACndex.json= `` file in the > -repository and restore it to '-'. This will dump the content to the stan= dard output. > +To get the contents of any archive, you can restore the ``=C3=ACndex.jso= n`` file in the > +repository to the target path '-'. This will dump the contents to the st= andard output. > =20 > .. code-block:: console > =20 > @@ -765,7 +765,7 @@ working directory and list directory contents in the = archive. > ``pwd`` shows the full path of the current working directory with respec= t to the > archive root. > =20 > -Being able to quickly search the contents of the archive is a often need= ed feature. > +Being able to quickly search the contents of the archive is a commmonly = needed feature. > That's where the catalog is most valuable. > For example: > =20 > @@ -814,10 +814,10 @@ file archive as a read-only filesystem to a mountpo= int on your host. > bin dev home lib32 libx32 media opt root sbin sys usr > boot etc lib lib64 lost+found mnt proc run srv tmp var > =20 > -This allows you to access the full content of the archive in a seamless = manner. > +This allows you to access the full contents of the archive in a seamless= manner. > =20 > .. note:: As the FUSE connection needs to fetch and decrypt chunks from = the > - backup servers datastore, this can cause some additional network and= CPU > + backup server's datastore, this can cause some additional network an= d CPU > load on your host, depending on the operations you perform on the mo= unted > filesystem. > =20 > @@ -914,7 +914,7 @@ backup is retained. > =20 > =20 > You can use the ``--dry-run`` option to test your settings. This only > -shows the list of existing snapshots and which action prune would take. > +shows the list of existing snapshots and what actions prune would take. > =20 > .. code-block:: console > =20 > --=20 > 2.20.1 >=20 >=20 >=20 > _______________________________________________ > pbs-devel mailing list > pbs-devel@lists.proxmox.com > https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel