docs: add epilog.rst to define common things.

diff --git a/docs/conf.py b/docs/conf.py
index dbc1cb055720bb2a95be2c4e7774bcf74ac629d0..ec168594b1c033c530e2afaaaf2bac598c61fac4 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -48,6 +48,9 @@ source_suffix = '.rst'
 # The master toctree document.
 master_doc = 'index'
 
+epilog_file = open('epilog.rst', 'r')
+rst_epilog = epilog_file.read()
+
 # General information about the project.
 project = 'Proxmox Backup'
 copyright = '2019, Proxmox Support Team'
@@ -84,6 +87,7 @@ language = None
 exclude_patterns = [
     '_build', 'Thumbs.db', '.DS_Store',
     'proxmox-backup-client/man1.rst',
+    'epilog.rst',
     'pbs-copyright.rst',
 ]
 

diff --git a/docs/epilog.rst b/docs/epilog.rst
new file mode 100644 (file)
index 0000000..8293e5c
--- /dev/null
+++ b/docs/epilog.rst
@@ -0,0 +1,11 @@
+.. Epilog (included at top of each file)
+   
+   We use this file to define external links and commone replacement
+   patterns.
+
+.. _Container: https://en.wikipedia.org/wiki/Container_(virtualization)
+.. _Proxmox Virtual Environment: https://www.proxmox.com/proxmox-ve
+.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
+.. _Rust: https://www.rust-lang.org/
+.. _Sphinx: https://www.sphinx-doc.org
+.. _Virtual machine: https://en.wikipedia.org/wiki/Virtual_machine

diff --git a/docs/glossary.rst b/docs/glossary.rst
index b213851c05b0a33e7e1b895d5b0bf80c56c96ed9..ac79f0592a260d82995d4ac5af1ab5b71dac42c8 100644 (file)
--- a/docs/glossary.rst
+++ b/docs/glossary.rst
@@ -3,6 +3,24 @@ Glossary
 
 .. glossary::
 
+   `Virtual machine`_
+
+      A Virtual machine is a program that can execute an entire
+      operatin system inside an emulated hardware environment.
+
+   `Container`_
+
+      A Container is an isolated user space. Programs runs directly on
+      the hosts kernel, but with limited access to the host resources.
+
+   `Rust`_
+
+      Rust is a new, fast and memory-efficient system programming
+      language, with no runtime or garbage collector. Rust’s rich type
+      system and ownership model guarantee memory-safety and
+      thread-safety. I can eliminate many classes of bugs
+      at compile-time.
+
    `Sphinx`_
 
       Is a tool that makes it easy to create intelligent and
@@ -16,7 +34,3 @@ Glossary
 
       Is an easy-to-read, what-you-see-is-what-you-get plaintext
       markup syntax and parser system.
-
-
-.. _Sphinx: https://www.sphinx-doc.org
-.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html

diff --git a/docs/introduction.rst b/docs/introduction.rst
index c48ca9d12d125f1ca0fd90f28a1a452deefc1fdb..b796f52f95aaa80bf8f142eddac93513ef5ad191 100644 (file)
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -11,6 +11,28 @@ Why Backup?
 dfgfd fghfgh fh
 
 
+Features
+--------
+
+:Proxmox VE: The `Proxmox Virtual Environment`_ is fully
+   supported. You can backup :term:`virtual machine`\ s and
+   :term:`container`\ s.
+
+:GUI: We provide a graphical, web based user interface.
+
+:Deduplication: Inkremental backup produces large amounts of duplicate
+   data. The deduplication layer removes that redundancy and makes
+   inkremental backup small and space efficient.
+
+:Remote Sync: It is possible to efficently synchronize data to remote
+   sites. Only deltas containing new data are transfered.
+
+:Performance: The whole software stack is written in :term:`Rust`,
+   which provides high speed and memory efficiency.
+
+:Open Source: No secrets. You have access to the whole source tree.
+
+
 History
 -------