tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: use case-matching keys for glossary 

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>
This commit is contained in:
Stoiko Ivanov 2022-05-16 16:27:30 +00:00 committed by Thomas Lamprecht
parent bffc923420
commit e1dc2d2210
2 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/introduction.rst
View File

@ -5,10 +5,11 @@ What is Proxmox Backup Server?
------------------------------ ------------------------------
Proxmox Backup Server is an enterprise-class, client-server backup solution that 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 is capable of backing up :term:`virtual machine<Virtual machine>`\ s,
physical hosts. It is specially optimized for the `Proxmox Virtual Environment`_ :term:`container<Container>`\ s, and physical hosts. It is specially optimized
platform and allows you to back up your data securely, even between remote for the `Proxmox Virtual Environment`_ platform and allows you to back up your
sites, providing easy management through a web-based user interface. data securely, even between remote sites, providing easy management through a
web-based user interface.
It supports deduplication, compression, and authenticated It supports deduplication, compression, and authenticated
encryption (AE_). Using :term:`Rust` as the implementation language guarantees 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. integrated client.
A single backup is allowed to contain several archives. For example, when you 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 backup a :term:`virtual machine<Virtual machine>`, each disk is stored as a
inside that backup. The VM configuration itself is stored as an extra file. separate archive inside that backup. The VM configuration itself is stored as
This way, it's easy to access and restore only the important parts of the an extra file. This way, it's easy to access and restore only the important
backup, without the need to scan the whole backup. parts of the backup, without the need to scan the whole backup.
Main Features Main Features
------------- -------------
:Support for Proxmox VE: The `Proxmox Virtual Environment`_ is fully :Support for Proxmox VE: The `Proxmox Virtual Environment`_ is fully
supported, and you can easily backup :term:`virtual machine`\ s and supported, and you can easily backup :term:`virtual machine<Virtual machine>`\ s and
:term:`container`\ s. :term:`container<Container>`\ s.
:Performance: The whole software stack is written in :term:`Rust`, :Performance: The whole software stack is written in :term:`Rust`,
in order to provide high speed and memory efficiency. in order to provide high speed and memory efficiency.

11
docs/terminology.rst
View File

@ -77,13 +77,14 @@ Backup Type
The backup server groups backups by *type*, where *type* is one of: The backup server groups backups by *type*, where *type* is one of:
``vm`` ``vm``
This type is used for :term:`virtual machine`\ s. It typically This type is used for :term:`virtual machine<Virtual machine>`\ s. It
consists of the virtual machine's configuration file and an image archive typically consists of the virtual machine's configuration file and an image
for each disk. archive for each disk.
``ct`` ``ct``
This type is used for :term:`container`\ s. It consists of the container's This type is used for :term:`container<Container>`\ s. It consists of the
configuration and a single file archive for the filesystem's contents. container's configuration and a single file archive for the filesystem's
contents.
``host`` ``host``
This type is used for file/directory backups created from within a machine. This type is used for file/directory backups created from within a machine.