Dylan Whyte
aef4976801
docs: admin guide: fix grammatical errors and improve English
...
Mostly fixed typos and grammatical errors.
Improved wording in some sections to make instructions/advice clearer.
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2020-07-20 14:10:39 +02:00
Thomas Lamprecht
34389132d9
docs: installation: add note where to find the webinterface
...
As the 8007 vs 8006 port is new and could confuse people, especially
if they did not used the PBS installer.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-14 07:35:59 +02:00
Thomas Lamprecht
78ee20d72d
docs: fix typo s/PBS_REPOSTOR/PBS_REPOSITOR/
...
Reported-by: Piotr Paszkowski aka patefoniQ
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-13 19:23:50 +02:00
Thomas Lamprecht
e1897b363b
docs: add secure-apt
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-10 14:12:51 +02:00
Thomas Lamprecht
33a87bc39a
docs: reference PDF variant in HTML output
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-09 21:31:38 +02:00
Thomas Lamprecht
7ba2c1c386
docs: add initial basic software stack definition
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-09 17:09:05 +02:00
Stoiko Ivanov
22231524e2
docs: expand datastore documentation
...
document retention settings and schedules per datastore with
some minimal examples.
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2020-07-09 15:04:26 +02:00
Stoiko Ivanov
9634ca07db
docs: add remotes and sync-jobs and schedules
...
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2020-07-09 15:04:26 +02:00
Wolfgang Bumiller
512d50a455
typos
...
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2020-07-09 09:34:58 +02:00
Thomas Lamprecht
b2bfb46835
docs: package repos: drop non-tests for now
...
they won't work and thus just confuse people, re-add them once we're
releasing final.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-08 18:17:55 +02:00
Thomas Lamprecht
24406ebc0c
docs: move host sysadmin out to own chapter, fix ZFS one
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-08 18:15:33 +02:00
Thomas Lamprecht
1f24d9114c
docs: add missing todos
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-08 18:14:17 +02:00
Oguz Bektas
859fe9c1fb
add local-zfs.rst
...
content is > 90% same as local-zfs.adoc in pve-docs.
adapted the format for .rst
fixed some typos and wrote some parts slightly different (wording).
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2020-07-08 16:49:40 +02:00
Thomas Lamprecht
067fe514e6
docs: fix repo paths
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-08 15:41:09 +02:00
Oguz Bektas
8c6e5ce23c
improve administration guide
...
fixing some typos and grammar errors.
added example file layout for datastores.
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2020-07-08 14:20:49 +02:00
Thomas Lamprecht
56b814e378
docs: add getting help section
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-07 13:24:39 +02:00
Thomas Lamprecht
0c136efe30
docs: features: minor wording
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-07 13:23:17 +02:00
Thomas Lamprecht
cdead6cd12
docs: drop initial out of context sentence
...
the footer mentions sphinx and this feels weird to read as user
(which doesn't really cares what language/format the source of the
docs are in)
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-07 13:22:03 +02:00
Thomas Lamprecht
3a9988638b
docs: move todolist to own document, don't link in release build
...
It is always build for html, but not linked if the devbuild tag isn't
set. This tag is set in the Makefile if the $(BUILD_MODE) variable
isn't "release".
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-06 14:44:53 +02:00
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