public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
* [pbs-devel] [PATCH docs 1/2] introduction: history: minor rewording and fixup
@ 2020-10-14 14:19 Dylan Whyte
  2020-10-14 14:19 ` [pbs-devel] [PATCH docs 2/2] Introduction: reword & link to encryption section Dylan Whyte
  2020-10-15  4:29 ` [pbs-devel] applied: [PATCH docs 1/2] introduction: history: minor rewording and fixup Dietmar Maurer
  0 siblings, 2 replies; 4+ messages in thread
From: Dylan Whyte @ 2020-10-14 14:19 UTC (permalink / raw)
  To: pbs-devel

Some minor spelling and grammar fixes.
Rewording of some sentences.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
 docs/introduction.rst | 35 +++++++++++++++++------------------
 1 file changed, 17 insertions(+), 18 deletions(-)

diff --git a/docs/introduction.rst b/docs/introduction.rst
index bf42f2ad..e28331a3 100644
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -179,29 +179,28 @@ along with this program.  If not, see AGPL3_.
 History
 -------
 
-Backup is, and always was, as central aspect of IT administration.
-The need to recover from data loss is fundamental and increases with
+Backup is, and always has been, a central aspect of IT administration.
+The need to recover from data loss is fundamental and only increases with
 virtualization.
 
-Not surprisingly, we shipped a backup tool with Proxmox VE from the
-beginning. The tool is called ``vzdump`` and is able to make
+For this reason, we've been shipping a backup tool with Proxmox VE, from the
+beginning. This tool is called ``vzdump`` and is able to make
 consistent snapshots of running LXC containers and KVM virtual
 machines.
 
-But ``vzdump`` only allowed for full backups. While this is perfect
+However, ``vzdump`` only allows for full backups. While this is fine
 for small backups, it becomes a burden for users with large VMs. Both
-backup time and space usage was too large for this case, specially
-when Users want to keep many backups of the same VMs. We need
-deduplication and incremental backups to solve those problems.
+backup duration and storage usage are too high for this case, especially
+for users who want to keep many backups of the same VMs. To solve these
+problems, we needed to offer deduplication and incremental backups.
 
-Back in October 2018 development started. We had been looking into
+Back in October 2018, development started. We investigated
 several technologies and frameworks and finally decided to use
-:term:`Rust` as implementation language to provide high speed and
-memory efficiency. The 2018-edition of Rust seemed to be promising and
-useful for our requirements.
-
-In July 2020 we released the first beta version of Proxmox Backup
-Server, followed by a first stable version in November 2020. With the
-support of incremental, fully deduplicated backups, Proxmox Backup
-significantly reduces the network load and saves valuable storage
-space.
+:term:`Rust` as the implementation language, in order to provide high speed and
+memory efficiency. The 2018-edition of Rust seemed promising for our
+requirements.
+
+In July 2020, we released the first beta version of Proxmox Backup
+Server, followed by the first stable version in November 2020. With support for
+incremental, fully deduplicated backups, Proxmox Backup significantly reduces
+network load and saves valuable storage space.
-- 
2.20.1





^ permalink raw reply	[flat|nested] 4+ messages in thread

* [pbs-devel] [PATCH docs 2/2] Introduction: reword & link to encryption section
  2020-10-14 14:19 [pbs-devel] [PATCH docs 1/2] introduction: history: minor rewording and fixup Dylan Whyte
@ 2020-10-14 14:19 ` Dylan Whyte
  2020-10-15  4:32   ` Dietmar Maurer
  2020-10-15  4:29 ` [pbs-devel] applied: [PATCH docs 1/2] introduction: history: minor rewording and fixup Dietmar Maurer
  1 sibling, 1 reply; 4+ messages in thread
From: Dylan Whyte @ 2020-10-14 14:19 UTC (permalink / raw)
  To: pbs-devel

Add link from encryption sentence in  "What is Proxmox
Backup Server?" to the Encryption section of the docs.
Also, reword the sentence.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
 docs/backup-client.rst | 2 ++
 docs/introduction.rst  | 9 +++++----
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/docs/backup-client.rst b/docs/backup-client.rst
index 946f3803..7270a37e 100644
--- a/docs/backup-client.rst
+++ b/docs/backup-client.rst
@@ -246,6 +246,8 @@ Restoring this backup will result in:
     .  ..  file2
 
 
+.. _encryption:
+
 Encryption
 ----------
 
diff --git a/docs/introduction.rst b/docs/introduction.rst
index e28331a3..ce60be33 100644
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -1,7 +1,7 @@
 Introduction
 ============
 
-What is Proxmox Backup Server
+What is Proxmox Backup Server?
 -----------------------------
 
 Proxmox Backup Server is an enterprise-class, client-server backup software
@@ -10,12 +10,13 @@ physical hosts. It is specially optimized for the `Proxmox Virtual Environment`_
 platform and allows you to back up your data securely, even between remote
 sites, providing easy management with a web-based user interface.
 
-Proxmox Backup Server supports deduplication, compression, and authenticated
+It supports deduplication, compression, and authenticated
 encryption (AE_). Using :term:`Rust` as the implementation language guarantees high
 performance, low resource usage, and a safe, high-quality codebase.
 
-It features strong client-side encryption. Thus, it's possible to
-backup data to targets that are not fully trusted.
+Proxmox Backup uses state of the art cryptography for client communication and
+backup content :ref:`encryption <encryption>`. Thus, it's possible to back up
+data to targets that are not fully trusted.
 
 
 Architecture
-- 
2.20.1





^ permalink raw reply	[flat|nested] 4+ messages in thread

* [pbs-devel] applied: [PATCH docs 1/2] introduction: history: minor rewording and fixup
  2020-10-14 14:19 [pbs-devel] [PATCH docs 1/2] introduction: history: minor rewording and fixup Dylan Whyte
  2020-10-14 14:19 ` [pbs-devel] [PATCH docs 2/2] Introduction: reword & link to encryption section Dylan Whyte
@ 2020-10-15  4:29 ` Dietmar Maurer
  1 sibling, 0 replies; 4+ messages in thread
From: Dietmar Maurer @ 2020-10-15  4:29 UTC (permalink / raw)
  To: Proxmox Backup Server development discussion, Dylan Whyte

applied, thanks!




^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [pbs-devel] [PATCH docs 2/2] Introduction: reword & link to encryption section
  2020-10-14 14:19 ` [pbs-devel] [PATCH docs 2/2] Introduction: reword & link to encryption section Dylan Whyte
@ 2020-10-15  4:32   ` Dietmar Maurer
  0 siblings, 0 replies; 4+ messages in thread
From: Dietmar Maurer @ 2020-10-15  4:32 UTC (permalink / raw)
  To: Proxmox Backup Server development discussion, Dylan Whyte

I am not really happy with this change. It is important to mention that
encryption is done "client side". Can we keep that somehow?


> -It features strong client-side encryption. Thus, it's possible to
> -backup data to targets that are not fully trusted.
> +Proxmox Backup uses state of the art cryptography for client communication and
> +backup content :ref:`encryption <encryption>`. Thus, it's possible to back up
> +data to targets that are not fully trusted.
>  
>  
>  Architecture
> -- 
> 2.20.1
> 
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel




^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2020-10-15  4:32 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-14 14:19 [pbs-devel] [PATCH docs 1/2] introduction: history: minor rewording and fixup Dylan Whyte
2020-10-14 14:19 ` [pbs-devel] [PATCH docs 2/2] Introduction: reword & link to encryption section Dylan Whyte
2020-10-15  4:32   ` Dietmar Maurer
2020-10-15  4:29 ` [pbs-devel] applied: [PATCH docs 1/2] introduction: history: minor rewording and fixup Dietmar Maurer

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