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 D550867007 for ; Wed, 29 Jul 2020 12:21:10 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id CA1C2DA50 for ; Wed, 29 Jul 2020 12:21:10 +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 DDF56DA48 for ; Wed, 29 Jul 2020 12:21:09 +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 23BE6433DE for ; Wed, 29 Jul 2020 12:21:02 +0200 (CEST) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Wed, 29 Jul 2020 12:20:48 +0200 Message-Id: <20200729102048.24465-1-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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: [pbs-devel] [PATCH pbs-docs] introduction: language improvement (fix typos, grammar, wording) 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: Wed, 29 Jul 2020 10:21:10 -0000 Fix typos and grammatical errors. Reword some sentences for better readability. Clean up the list found under "Software Stack", so that it maintains a consistent style throughout. --- docs/introduction.rst | 44 +++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/introduction.rst b/docs/introduction.rst index cca8109b..9df0762f 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -15,7 +15,7 @@ encryption (AE_). Using :term:`Rust` as the implementation language guarantees h performance, low resource usage, and a safe, high-quality codebase. It features strong client-side encryption. Thus, it's possible to -backup data to not fully trusted targets. +backup data to targets that are not fully trusted. Architecture @@ -23,7 +23,7 @@ Architecture Proxmox Backup Server uses a `client-server model`_. The server stores the backup data and provides an API to create backups and restore data. With the -API it's also possible to manage disks and other server side resources. +API, it's also possible to manage disks and other server-side resources. The backup client uses this API to access the backed up data. With the command line tool ``proxmox-backup-client`` you can create backups and restore data. @@ -32,7 +32,7 @@ For QEMU_ with `Proxmox Virtual Environment`_ we deliver an integrated client. A single backup is allowed to contain several archives. For example, when you backup a :term:`virtual machine`, each disk is stored as a separate archive inside that backup. The VM configuration itself is stored as an extra file. -This way, it is easy to access and restore only important parts of the backup +This way, it's easy to access and restore only important parts of the backup, without the need to scan the whole backup. @@ -44,29 +44,29 @@ Main Features :term:`container`\ s. :Performance: The whole software stack is written in :term:`Rust`, - to provide high speed and memory efficiency. + in order to provide high speed and memory efficiency. :Deduplication: Periodic backups produce large amounts of duplicate - data. The deduplication layer avoids redundancy and minimizes the used - storage space. + data. The deduplication layer avoids redundancy and minimizes the storage + space used. :Incremental backups: Changes between backups are typically low. Reading and - sending only the delta reduces storage and network impact of backups. + sending only the delta reduces the storage and network impact of backups. -:Data Integrity: The built-in `SHA-256`_ checksum algorithm assures the - accuracy and consistency of your backups. +:Data Integrity: The built-in `SHA-256`_ checksum algorithm ensures accuracy and + consistency in your backups. :Remote Sync: It is possible to efficiently synchronize data to remote sites. Only deltas containing new data are transferred. -:Compression: The ultra fast Zstandard_ compression is able to compress +:Compression: The ultra-fast Zstandard_ compression is able to compress several gigabytes of data per second. -:Encryption: Backups can be encrypted on the client-side using AES-256 in +:Encryption: Backups can be encrypted on the client-side, using AES-256 in Galois/Counter Mode (GCM_) mode. This authenticated encryption (AE_) mode provides very high performance on modern hardware. -:Web interface: Manage the Proxmox Backup Server with the integrated web-based +:Web interface: Manage the Proxmox Backup Server with the integrated, web-based user interface. :Open Source: No secrets. Proxmox Backup Server is free and open-source @@ -80,11 +80,11 @@ Reasons for Data Backup? ------------------------ The main purpose of a backup is to protect against data loss. Data loss can be -caused by faulty hardware but also by human error. +caused by both faulty hardware and human error. A common mistake is to accidentally delete a file or folder which is still -required. Virtualization can even amplify this problem; it easily happens that -a whole virtual machine is deleted by just pressing a single button. +required. Virtualization can even amplify this problem, as deleting a whole +virtual machine can be as easy as pressing a single button. For administrators, backups can serve as a useful toolkit for temporarily storing data. For example, it is common practice to perform full backups before @@ -104,16 +104,16 @@ Software Stack Proxmox Backup Server consists of multiple components: -* server-daemon providing, among others, a RESTfull API, super-fast +* A server-daemon providing, among other things, a RESTfull API, super-fast asynchronous tasks, lightweight usage statistic collection, scheduling events, strict separation of privileged and unprivileged execution - environments, ... -* JavaScript management webinterface -* management CLI tool for the server (`proxmox-backup-manager`) -* client CLI tool (`proxmox-backup-client`) to access the server easily from - any `Linux amd64` environment. + environments +* A JavaScript management web interface +* A management CLI tool for the server (`proxmox-backup-manager`) +* A client CLI tool (`proxmox-backup-client`) to access the server easily from + any `Linux amd64` environment -Everything outside of the web interface is written in the Rust programming +Aside from the web interface, everything is written in the Rust programming language. "The Rust programming language helps you write faster, more reliable software. -- 2.20.1