Commit Graph

85 Commits

Author SHA1 Message Date
Thomas Lamprecht
5f249127b2 docs: sync version with the package versions
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-05-25 20:10:38 +02:00
Dietmar Maurer
a66d5898a1 docs/administration-guide.rst: fix prune command output 2020-05-05 07:24:27 +02:00
Dietmar Maurer
96feecd621 administration-guide.rst: update snapshot list output 2020-05-04 13:14:03 +02:00
Dietmar Maurer
f9dcfa4149 administration-guide.rst: add section "Proxmox VE integration" 2020-05-04 12:41:38 +02:00
Dietmar Maurer
25cf09065f docs: use OpenSans as main font
Most people also read PDFs online ...
2020-05-04 10:48:09 +02:00
Dietmar Maurer
fc598cdbe1 docs: use better fonts for PDFs
Font XCharter and Lato have better quality.
2020-05-04 10:15:27 +02:00
Dietmar Maurer
bca294a17c docs/conf.py: avoid font scale option 2020-05-04 09:02:10 +02:00
Dietmar Maurer
a02e8b1e95 docs/conf.py: fix baselineskip in code-blocks with scaled font 2020-05-03 09:22:01 +02:00
Dietmar Maurer
26d29e0ec7 pdf docs: scale down monospace font 2020-05-03 08:23:35 +02:00
Dietmar Maurer
15d74eaaf4 use xetex to generate pdf
To correctly handle unicode art in code blocks...
2020-05-03 07:48:55 +02:00
Dietmar Maurer
8df51d4852 administration-guide.rst: add role definitions 2020-05-02 16:40:20 +02:00
Dietmar Maurer
8f3b3cc1f9 administration-guide.rst: add example to disable/remove a user 2020-05-02 11:21:05 +02:00
Dietmar Maurer
17ec699d79 administration-guide.rst: start user management docs 2020-05-02 11:11:36 +02:00
Aaron Lauterer
4f3db187cf Docu: first proof reading
This is a first proof reading of the currently existing documentation.

fixes (hopefully all):
* spelling
* grammar

Tries to increase readabilty and ease of understanding by simplifying
and restructing some sentences and paragraphs. Filler words which add
to the cognitive load but don't add anything are removed
(most notably `also`).
2020-04-15 06:52:59 +02:00
Dietmar Maurer
53ea655669 docs/administration-guide.rst: add small section to explain output-format 2020-02-28 12:26:39 +01:00
Dietmar Maurer
f40cf85212 docs/epilig.rst: remove fuse to avoid RST warnings 2020-02-28 11:55:25 +01:00
Christian Ebner
cee53b34df docs: add documentation for pxar
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-02-25 10:49:20 +01:00
Christian Ebner
e899d33e49 docs: fix typo
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-02-20 10:16:51 +01:00
Christian Ebner
50b8f9dd67 docs: Add documentation for .pxarexclude files
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-02-20 10:16:28 +01:00
Dietmar Maurer
3243f93ce7 administration-guide.rst: documnet new PBS_FINGERPRINT env var 2020-02-11 12:06:02 +01:00
Christian Ebner
f0188322ed docs: fix typos
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-01-31 07:05:52 +01:00
Christian Ebner
c7971d7f8f docs: Add documentation for mounting pxar archives via FUSE.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-01-31 07:05:40 +01:00
Christian Ebner
3f0983b7a3 docs: Extend documentation on interactive restore with catalog shell.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-01-30 07:02:50 +01:00
Christian Ebner
d58de5db19 docs: s/RUST/Rust/
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-01-30 07:02:50 +01:00
Fabian Grünbichler
da0e1e4021 various packaging fixes, bump version
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2019-12-20 12:55:32 +01:00
Oguz Bektas
22b20d04b4 docs: fix typo in introduction.rst
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2019-12-18 17:14:58 +01:00
Dietmar Maurer
3c50a9d82e administration-guide.rst: fix catalog command syntax 2019-12-18 12:58:18 +01:00
Dietmar Maurer
236a396aa1 src/api2/admin/datastore.rs - prune: log retention options 2019-12-14 16:32:16 +01:00
Dietmar Maurer
e1c356ec06 docs/administration-guide.rst: document garbage collection 2019-12-14 15:52:25 +01:00
Dietmar Maurer
720776b81e generate separate proxmox-backup-docs package 2019-12-13 14:15:07 +01:00
Dietmar Maurer
102d8d4136 src/backup/prune.rs: implement --keep-hourly 2019-12-07 11:23:33 +01:00
Dietmar Maurer
1af6637004 docs/administration-guide.rst: add hint about ISO week date 2019-12-07 10:45:43 +01:00
Dietmar Maurer
84322d8c75 docs/administration-guide.rst: doc prune --dry-run 2019-12-06 19:20:05 +01:00
Dietmar Maurer
5ab52d9a8a docs/command-syntax.rst: include catalog-shell-synopsis.rst 2019-12-06 13:46:02 +01:00
Dietmar Maurer
4bf0cc3b41 proxmox-backup-client/man1.rst: include catalog shell commands 2019-12-06 10:08:11 +01:00
Dietmar Maurer
02d22dec4d docs/administration-guide.rst: explain how prune handles uncomplete backups 2019-12-05 11:27:42 +01:00
Dietmar Maurer
52b2be979d docs/administration-guide.rst: improve prune docs 2019-12-05 09:43:46 +01:00
Dietmar Maurer
6e5a0c03fa docs/administration-guide.rst: add prune docs 2019-12-04 13:46:57 +01:00
Dietmar Maurer
ac456d85e8 docs/administration-guide.rst: describe login/logout 2019-12-04 10:47:41 +01:00
Dietmar Maurer
ed858b0af4 docs/administration-guide.rst: minor cleanups 2019-12-03 16:58:34 +01:00
Dietmar Maurer
c5ff124143 docs/Makefile: remove paper settings (we set that in conf.py) 2019-12-03 16:51:43 +01:00
Dietmar Maurer
64b85116eb docs/administration-guide.rst: explain restore 2019-12-03 16:19:30 +01:00
Dietmar Maurer
5a499f3281 docs/administration-guide.rst: add encryption section 2019-12-03 15:24:04 +01:00
Dietmar Maurer
a129fdd9cc docs/administration-guide.rst: improve section "Creating Backups" 2019-12-03 11:59:00 +01:00
Dietmar Maurer
57905a61b1 docs/administration-guide.rst: improve section "Backup Content" 2019-12-03 09:04:49 +01:00
Dietmar Maurer
2938a0a788 docs/installation.rst: replace FIXME with todo items 2019-12-03 08:32:03 +01:00
Dietmar Maurer
b10bf87117 docs/introduction.rst: improve "Why Backup" section. 2019-12-03 08:18:52 +01:00
Dietmar Maurer
45cc157f7c docs: add backup reader protocol 2019-11-22 06:59:37 +01:00
Dietmar Maurer
e4a5ab8ddb add pxar.1 manual page 2019-11-17 17:13:59 +01:00
Dietmar Maurer
85e139b70f docs/administration-guide.rs: add 'Backup Content' section. 2019-11-17 16:51:40 +01:00