all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Stoiko Ivanov <s.ivanov@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 3/6] docs: use case-matching keys for glossary
Date: Mon, 16 May 2022 16:27:30 +0000	[thread overview]
Message-ID: <20220516162733.62060-4-s.ivanov@proxmox.com> (raw)
In-Reply-To: <20220516162733.62060-1-s.ivanov@proxmox.com>

this silences warnings a la:
```
WARNING: term container not found in case sensitive match.made a
reference to Container instead
```
the issue is purely cosmetic during build, and should vanish in a newer
version of sphinx-doc [0].

[0] https://github.com/sphinx-doc/sphinx/issues/7636

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
---
 docs/introduction.rst | 21 +++++++++++----------
 docs/terminology.rst  | 11 ++++++-----
 2 files changed, 17 insertions(+), 15 deletions(-)

diff --git a/docs/introduction.rst b/docs/introduction.rst
index ed1816d3..47b5d606 100644
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -5,10 +5,11 @@ What is Proxmox Backup Server?
 ------------------------------
 
 Proxmox Backup Server is an enterprise-class, client-server backup solution that
-is capable of backing up :term:`virtual machine`\ s, :term:`container`\ s, and
-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 through a web-based user interface.
+is capable of backing up :term:`virtual machine<Virtual machine>`\ s,
+:term:`container<Container>`\ s, and 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 through a
+web-based user interface.
 
 It supports deduplication, compression, and authenticated
 encryption (AE_). Using :term:`Rust` as the implementation language guarantees
@@ -34,18 +35,18 @@ For QEMU_ and LXC_ within `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's easy to access and restore only the important parts of the
-backup, without the need to scan the whole backup.
+backup a :term:`virtual machine<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's easy to access and restore only the important
+parts of the backup, without the need to scan the whole backup.
 
 
 Main Features
 -------------
 
 :Support for Proxmox VE: The `Proxmox Virtual Environment`_ is fully
-   supported, and you can easily backup :term:`virtual machine`\ s and
-   :term:`container`\ s.
+   supported, and you can easily backup :term:`virtual machine<Virtual machine>`\ s and
+   :term:`container<Container>`\ s.
 
 :Performance: The whole software stack is written in :term:`Rust`,
    in order to provide high speed and memory efficiency.
diff --git a/docs/terminology.rst b/docs/terminology.rst
index c5551818..1e12f9c1 100644
--- a/docs/terminology.rst
+++ b/docs/terminology.rst
@@ -68,13 +68,14 @@ Backup Type
 The backup server groups backups by *type*, where *type* is one of:
 
 ``vm``
-    This type is used for :term:`virtual machine`\ s. It typically
-    consists of the virtual machine's configuration file and an image archive
-    for each disk.
+    This type is used for :term:`virtual machine<Virtual machine>`\ s. It
+    typically consists of the virtual machine's configuration file and an image
+    archive for each disk.
 
 ``ct``
-    This type is used for :term:`container`\ s. It consists of the container's
-    configuration and a single file archive for the filesystem's contents.
+    This type is used for :term:`container<Container>`\ s. It consists of the
+    container's configuration and a single file archive for the filesystem's
+    contents.
 
 ``host``
     This type is used for file/directory backups created from within a machine.
-- 
2.30.2





  parent reply	other threads:[~2022-05-16 16:27 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-16 16:27 [pbs-devel] [PATCH proxmox-backup 0/6] docs: cleanup and add certificate docs Stoiko Ivanov
2022-05-16 16:27 ` [pbs-devel] [PATCH proxmox-backup 1/6] docs: silence duplicate label warnings Stoiko Ivanov
2022-05-16 16:27 ` [pbs-devel] [PATCH proxmox-backup 2/6] docs: cleanup and readd command-line-tools Stoiko Ivanov
2022-05-16 16:27 ` Stoiko Ivanov [this message]
2022-05-16 16:27 ` [pbs-devel] [PATCH proxmox-backup 4/6] docs: add certificate-management.rst Stoiko Ivanov
2022-05-16 16:27 ` [pbs-devel] [PATCH proxmox-backup 5/6] docs: certificates Stoiko Ivanov
2022-05-16 16:27 ` [pbs-devel] [PATCH proxmox-backup 6/6] docs: certs: add screenshots Stoiko Ivanov
2022-05-16 17:28 ` [pbs-devel] applied: [PATCH proxmox-backup 0/6] docs: cleanup and add certificate docs Thomas Lamprecht

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=20220516162733.62060-4-s.ivanov@proxmox.com \
    --to=s.ivanov@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal