Thomas Lamprecht
8a25809573
docs: sync up copyright years
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-04 17:57:47 +02:00
Thomas Lamprecht
d87b193b0b
docs: todo: avoid leaking build details, link only
...
One can just search for them... If really wanted, we could set it to
true for dev builds (i.e., no DEB_VERSION defined)
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-04 17:54:00 +02:00
Thomas Lamprecht
1f6a4f587a
docs: do not hardcode version
...
use the debian package ones, if not defined we're doing a dev build
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-04 17:51:58 +02:00
Thomas Lamprecht
d2c7ef09ba
docs: rework and add a bit to introduction
...
Contributed-by: Daniela Häsler <daniela@proxmox.com>
[ discussed and edited some parts live with me, Thomas ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-03 18:58:17 +02:00
Thomas Lamprecht
27f86f997e
docs: fix index title
...
Contributed-by: Daniela Häsler <daniela@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-03 18:57:04 +02:00
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
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
Dietmar Maurer
d2a8d597e4
introduction.rst: Add short Architecture section
2019-11-11 13:26:08 +01:00
Dietmar Maurer
7391b4cf71
package-repositories.rst: new file
2019-11-11 12:28:04 +01:00
Dietmar Maurer
028bd254ac
add manual page for proxmox-backup-manager
2019-11-11 09:17:55 +01:00
Dietmar Maurer
177db84b82
docs/backup-protocol.rst: add backup protocol docs
2019-06-04 17:33:12 +02:00
Dietmar Maurer
164d961729
docs/index.rst: cleanup
2019-03-19 12:22:57 +01:00
Dietmar Maurer
998b827a5d
start file format docu
2019-03-16 16:44:45 +01:00
Dietmar Maurer
d49746481c
docs: remove generated-index.rst and search-page.rst
...
This does not work as expected.
2019-03-05 18:36:22 +01:00
Dietmar Maurer
b933ed7f80
docs: add manual page for proxmox-backup-proxy
2019-03-05 18:14:48 +01:00
Dietmar Maurer
b246b2a635
docs: define author and version inside epilog.rst
2019-03-05 17:42:48 +01:00
Dietmar Maurer
59b9c7ef5a
docs: add support link
2019-03-02 18:23:48 +01:00
Dietmar Maurer
6253aa50a3
docs: add "What is Proxmox Backup"
2019-03-02 18:08:00 +01:00
Dietmar Maurer
0c56b0e693
docs: improve section "Why Backup"
2019-03-02 17:51:18 +01:00
Dietmar Maurer
efd3e76bda
docs: add more features
2019-03-02 16:56:01 +01:00
Dietmar Maurer
3147e56a74
docs: add epilog.rst to define common things.
2019-03-02 10:31:32 +01:00
Dietmar Maurer
1757747836
docs/glossary.rst: add hyperlinks
2019-02-28 19:23:48 +01:00
Dietmar Maurer
d823802ea1
docs: add glossary.rst
2019-02-28 19:09:55 +01:00
Dietmar Maurer
f13c36c856
docs: use exclude_pattern instead of :orphan:
...
Seems rst2man cannot handle :orphan:
2019-02-28 16:28:53 +01:00
Dietmar Maurer
7e688b7149
docs: improve ducument structure
2019-02-27 18:35:05 +01:00
Dietmar Maurer
7ef486ae06
build doc with sphinx
2019-02-27 17:42:31 +01:00
Dietmar Maurer
2e05a1ca7d
docs/Makefile: fix make dependency
2019-02-24 16:19:39 +01:00
Dietmar Maurer
f0b5a3adfa
docs/proxmox-backup.rst: start writing docs
2019-02-24 15:52:04 +01:00
Dietmar Maurer
bb5c770758
start generating manual pages
...
Depend on docutils-doc
2019-02-24 10:18:38 +01:00
