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 9CE77600F7 for ; Fri, 5 Feb 2021 16:11:04 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 90D31A9E6 for ; Fri, 5 Feb 2021 16:10:34 +0100 (CET) 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 8E86CA9D8 for ; Fri, 5 Feb 2021 16:10:32 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 595FE461F3 for ; Fri, 5 Feb 2021 16:10:32 +0100 (CET) From: Aaron Lauterer To: pbs-devel@lists.proxmox.com Date: Fri, 5 Feb 2021 16:10:29 +0100 Message-Id: <20210205151030.28946-1-a.lauterer@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 AWL -0.020 Adjusted score from AWL reputation of From: address 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 URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [wikipedia.org] Subject: [pbs-devel] [PATCH proxmox-backup 1/2] docs: fix references to changed refs 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: Fri, 05 Feb 2021 15:11:04 -0000 With commit ec1ae7e63180768c9ad8fa52d437a1cee6ef1c50 some refs were changed by getting prefixes and such. We need to adapt the places that reference them as well Signed-off-by: Aaron Lauterer --- docs/backup-client.rst | 2 +- docs/gui.rst | 2 +- docs/introduction.rst | 2 +- docs/maintenance.rst | 6 +++--- docs/managing-remotes.rst | 2 +- docs/pxar/description.rst | 2 +- docs/storage.rst | 4 ++-- docs/technical-overview.rst | 4 ++-- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/backup-client.rst b/docs/backup-client.rst index 800ee43f..415e5bf0 100644 --- a/docs/backup-client.rst +++ b/docs/backup-client.rst @@ -657,7 +657,7 @@ shows the list of existing snapshots and what actions prune would take. .. note:: Neither the ``prune`` command nor the ``forget`` command free space in the chunk-store. The chunk-store still contains the data blocks. To free - space you need to perform :ref:`garbage-collection`. + space you need to perform :ref:`client_garbage-collection`. .. _client_garbage-collection: diff --git a/docs/gui.rst b/docs/gui.rst index b2b1fb73..719675e9 100644 --- a/docs/gui.rst +++ b/docs/gui.rst @@ -129,7 +129,7 @@ top panel to view: * **Content**: Information on the datastore's backup groups and their respective contents * **Prune & GC**: Schedule :ref:`pruning ` and :ref:`garbage - collection ` operations, and run garbage collection + collection ` operations, and run garbage collection manually * **Sync Jobs**: Create, manage and run :ref:`syncjobs` from remote servers * **Verify Jobs**: Create, manage and run :ref:`maintenance_verification` jobs on the diff --git a/docs/introduction.rst b/docs/introduction.rst index 8545bf2c..5e754477 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. Proxmox Backup uses state of the art cryptography for both client-server -communication and backup content :ref:`encryption `. All +communication and backup content :ref:`encryption `. All client-server communication uses `TLS `_, and backup data can be encrypted on the client-side before sending, making it safer to back up data diff --git a/docs/maintenance.rst b/docs/maintenance.rst index 561b4fe4..c2771e36 100644 --- a/docs/maintenance.rst +++ b/docs/maintenance.rst @@ -118,11 +118,11 @@ high, but you cannot recreate backup snapshots from the past. Garbage Collection ------------------ -You can monitor and run :ref:`garbage collection ` on the +You can monitor and run :ref:`garbage collection ` on the Proxmox Backup Server using the ``garbage-collection`` subcommand of ``proxmox-backup-manager``. You can use the ``start`` subcommand to manually start garbage collection on an entire datastore and the ``status`` subcommand to -see attributes relating to the :ref:`garbage collection `. +see attributes relating to the :ref:`garbage collection `. This functionality can also be accessed in the GUI, by navigating to **Prune & GC** from the top panel. From here, you can edit the schedule at which garbage @@ -142,7 +142,7 @@ Verification Proxmox Backup offers various verification options to ensure that backup data is intact. Verification is generally carried out through the creation of verify jobs. These are scheduled tasks that run verification at a given interval (see -:ref:`calendar-events`). With these, you can set whether already verified +:ref:`calendar-event-scheduling`). With these, you can set whether already verified snapshots are ignored, as well as set a time period, after which verified jobs are checked again. The interface for creating verify jobs can be found under the **Verify Jobs** tab of the datastore. diff --git a/docs/managing-remotes.rst b/docs/managing-remotes.rst index e29ae37f..88ab3ba2 100644 --- a/docs/managing-remotes.rst +++ b/docs/managing-remotes.rst @@ -65,7 +65,7 @@ the ``proxmox-backup-manager sync-job`` command. The configuration information for sync jobs is stored at ``/etc/proxmox-backup/sync.cfg``. To create a new sync job, click the add button in the GUI, or use the ``create`` subcommand. After creating a sync job, you can either start it manually from the GUI or -provide it with a schedule (see :ref:`calendar-events`) to run regularly. +provide it with a schedule (see :ref:`calendar-event-scheduling`) to run regularly. .. code-block:: console diff --git a/docs/pxar/description.rst b/docs/pxar/description.rst index 18be7687..be78623d 100644 --- a/docs/pxar/description.rst +++ b/docs/pxar/description.rst @@ -80,7 +80,7 @@ These files must contain one pattern per line, again later patterns win over previous ones. The patterns control file exclusions of files present within the given directory or further below it in the tree. -The behavior is the same as described in :ref:`creating-backups`. +The behavior is the same as described in :ref:`client_creating_backups`. Extracting an Archive ^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/storage.rst b/docs/storage.rst index 45807b21..de3f0f46 100644 --- a/docs/storage.rst +++ b/docs/storage.rst @@ -119,8 +119,8 @@ directory on the filesystem. Each datastore also has associated retention settings of how many backup snapshots for each interval of ``hourly``, ``daily``, ``weekly``, ``monthly``, ``yearly`` as well as a time-independent number of backups to keep in that store. :ref:`backup-pruning` and -:ref:`garbage collection ` can also be configured to run -periodically based on a configured schedule (see :ref:`calendar-events`) per datastore. +:ref:`garbage collection ` can also be configured to run +periodically based on a configured schedule (see :ref:`calendar-event-scheduling`) per datastore. .. _storage_datastore_create: diff --git a/docs/technical-overview.rst b/docs/technical-overview.rst index 9dba2557..1bf59e23 100644 --- a/docs/technical-overview.rst +++ b/docs/technical-overview.rst @@ -7,8 +7,8 @@ Datastores ---------- A Datastore is the logical place where :ref:`Backup Snapshots -` and their chunks are stored. Snapshots consist of a -manifest, blobs, dynamic- and fixed-indexes (see :ref:`terminology`), and are +` and their chunks are stored. Snapshots consist of a +manifest, blobs, dynamic- and fixed-indexes (see :ref:`terms`), and are stored in the following directory structure: ///