Commit Graph

72 Commits

Author SHA1 Message Date
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
Dietmar Maurer fea8789cba docs/administration-guide.rst: add section termonology 2019-11-17 09:55:21 +01:00
Dietmar Maurer 85325c2502 docs/administration-guide.rs: move sysadmin.rst to the end 2019-11-17 09:09:51 +01:00
Dietmar Maurer 7ee2198e3b docs/introduction.rst: improve section Architecture 2019-11-17 08:47:22 +01:00
Dietmar Maurer bd61cafc69 docs/introduction.rst: add todo items 2019-11-16 11:50:56 +01:00
Dietmar Maurer 6a1cb69171 docs: improve introduction.rst 2019-11-16 11:43:14 +01:00
Dietmar Maurer 210cb53654 docs: enable sphinx todo items 2019-11-16 11:16:04 +01:00
Dietmar Maurer c4f1b69f4e docs: add sysadmin.rst, cleanups 2019-11-15 13:24:45 +01:00
Dietmar Maurer cb01363cfa docs: rename deployment-guide.rst -> administration-guide.rst
and join with admin-guide.rst
2019-11-15 12:35:31 +01:00
Dietmar Maurer 861f8b8f44 docs/conf.py: add exclude_pattern package-repositories.rst
The file is inlcuded with 'include' directive. Exclude it to avoid
avoid warning about duplicate label definition.
2019-11-15 11:55:31 +01:00
Dietmar Maurer 58ea88c8ab docs: add more ... 2019-11-13 13:10:56 +01:00
Dietmar Maurer 022b8350d9 add license for docs (GFDL) 2019-11-11 19:45:44 +01:00
Dietmar Maurer fdd471d590 docs/introduction.rst: Add License Section (AGPL3) 2019-11-11 19:21:27 +01:00
Dietmar Maurer 2501c57c2b docs/introduction.rst: add feature Encryption, replace LZ4 with Zstandard 2019-11-11 19:07:35 +01:00