Commit Graph

350 Commits

Author SHA1 Message Date
Thomas Lamprecht
4abb3edd9f docs: fix horizontal scrolling issues on desktop and mobile
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-03-24 18:24:39 +01:00
Thomas Lamprecht
932e69a837 docs: improve navigation coloring on mobile
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-03-24 18:24:20 +01:00
Thomas Lamprecht
52ea00e9df docs: only apply toctree color override to sidebar one
else the TOC on the index page has some white text on white back
ground

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-03-24 17:09:30 +01:00
Thomas Lamprecht
8498290848 docs: technically not everything is in rust/js
I mean the whole distro uses quite some C and the like as base, so
avoid being overly strict here.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-03-16 20:37:16 +01:00
Thomas Lamprecht
654db565cb docs: features: mention that there are no client/data limits
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-03-16 20:37:16 +01:00
Thomas Lamprecht
51f83548ed docs: drop uncommon spelled out GCM
It does not help users if that is spelled out, and its not a common
use of GCM, and especially in the AES 256 context its clear what is
meant. The link to Wikipedia stays, so interested people can still
read up on it and others get a better overview due to the text being
more concise.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-03-16 20:37:16 +01:00
Thomas Lamprecht
5847a6bdb5 docs: fix linking, avoid over long text in main feature list
The main feature list should provide a short overview of the, well,
main features. While enterprise support *is* a main and important
feature, it's not the place here to describe things like personal
volume/ngo/... offers and the like.

Move parts of it to getting help, which lacked mentioning the
enterprise support too and is a good place to describe the customer
portal.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-03-16 20:37:16 +01:00
Dylan Whyte
313e5e2047 docs: mention support subscription plans
and change enterprise repository section to present tense.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-03-16 19:24:23 +01:00
Dylan Whyte
70d00e0149 tape: documentation language fixup
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-03-10 11:05:30 +01:00
Dietmar Maurer
3f4a62de2f docs: fix note about global media pool namespace 2021-03-08 10:56:28 +01:00
Thomas Lamprecht
bf23f63aa5 docs: alabaster theme: better contrast for background color of topics
The old value just was way to heavy, and notes/warnings/...
admonitions did not stick out anymore.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-03-08 10:19:22 +01:00
Dietmar Maurer
225affc9ca tape: add docu link targets for online help 2021-03-08 09:37:40 +01:00
Dietmar Maurer
98cdee781a docs: use code-block inside tape-backup.rst 2021-03-06 12:20:26 +01:00
Dietmar Maurer
9cf4504909 docs: document tape backup jobs 2021-03-06 12:10:39 +01:00
Dylan Whyte
207f763d1a tfa docs: language fixup
Simplifies the introduction a bit and makes it more readable.
Also some other minor language fixes throughout the section.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-03-04 15:22:09 +01:00
Dietmar Maurer
d33d1c880b docs: mark tape backup as technology preview 2021-03-03 10:04:11 +01:00
Dylan Whyte
985e84e369 Fix 3321: fix interactive restore command explanation
The previous description in the docs was false. The restore command
with the pattern parameter will search the entire backup archive,
regardless of pwd.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-03-03 09:34:19 +01:00
Thomas Lamprecht
858bbfbbd1 doc: barcode gen: some eslint/code-style fixes
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-28 19:35:43 +01:00
Thomas Lamprecht
c1570b373f doc: barcode gen: allow label heights from 15 mm
Americans seem to sometimes use Avery 6577 which has 5/8" x 3"
labels, equaling 15.875 mm x 76.2 mm, so do not set the lower bound
to 17mm (which even breaks our used Avery 3240 sheets which have an
label height of 16.9 mm

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-28 19:32:43 +01:00
Thomas Lamprecht
d336363771 docs: barcode gen: fix acery3420 dimensions
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-28 19:31:35 +01:00
Dietmar Maurer
e57aa36d3e docs: add file extensions to file formats 2021-02-28 11:25:22 +01:00
Dietmar Maurer
b488f850aa docs: document fixed and dynamic index formats 2021-02-28 11:12:31 +01:00
Dietmar Maurer
ec07a280ba docs: document data blob format 2021-02-28 10:32:56 +01:00
Dietmar Maurer
5006632550 docs: improve backup protocol docs 2021-02-28 09:07:13 +01:00
Dietmar Maurer
7eb9f48485 doc: improve backup protocol docs 2021-02-27 12:44:03 +01:00
Dietmar Maurer
3832911d50 docs: remove backup protocol api dumps
We now have the api-viewer for that.
2021-02-26 19:00:08 +01:00
Dominik Csapak
28c86760da docs: use mathjax library from debian package instead of CDN
By default, sphinx embeds the cloudflare CDN version of mathjax. This
is bad for privacy, webistes enforcing cross-site origin protection
and in environments with no WAN access.

Luckily there's a Debian package we can use instead.

The config is the default sphinx config used.

Reported-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-26 18:05:36 +01:00
Thomas Lamprecht
c4604ca468 docs: adapt TOC styling to something a bit more light weight
marketing noted that it looked quite heavy weight, to the point where
it was hard to read to the full black squares, bold monospace text
and bottom borders with rather distinctive darkness.

Address those by:
* change color for list points from black to mid-dark grey
* use empty circles for second heading level
* ensure monospaced text has a normal font weight in the TOC headings
* some lighter color for the bottom border

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-26 18:01:39 +01:00
Dietmar Maurer
00fdaaf12b api-viewer: do not show permission for backup/restore protocol
Permission check is done before the H2 upgrade.
2021-02-23 10:04:16 +01:00
Thomas Lamprecht
0263396187 docs: fix some typos/grammar
Rund `codespell` tool, but it picked up not as much as I hoped.
Rest was found with vim + (hun)spell

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-22 18:08:59 +01:00
Dietmar Maurer
2037d9af03 api-viewer: show permissions 2021-02-22 12:01:24 +01:00
Dietmar Maurer
451856d21d api-viewer: fix path for upgraded HTTP/2 proptocls 2021-02-22 08:38:27 +01:00
Dietmar Maurer
cf95f616c5 add missing file docs/api-viewer/index.html 2021-02-21 10:04:23 +01:00
Dietmar Maurer
1adbc7c13c docs: install API viewer 2021-02-21 09:06:58 +01:00
Dietmar Maurer
9d28974c27 adopt PVEAPI.js for PBS, rename to PBSAPI.js 2021-02-21 09:06:58 +01:00
Dietmar Maurer
3dbc35b5c1 copy api-viewer from pve-docs 2021-02-21 09:06:58 +01:00
Dietmar Maurer
7ca0ba4515 tape: add tape-job.cfg manual page 2021-02-15 07:05:39 +01:00
Thomas Lamprecht
70dc2ff3ab docs/barcode: eslint auto-fixes
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-13 14:49:16 +01:00
Dietmar Maurer
81f5d03e8d docs: update benchmark results 2021-02-13 10:52:19 +01:00
Dietmar Maurer
28eaff20bd docs: fix target refs in user-management.rst 2021-02-13 10:23:02 +01:00
Dietmar Maurer
8d1a1b2976 docs: conv.py - add man pages to exclude_patterns
To avoid sphinx warnings.
2021-02-13 10:16:41 +01:00
Dietmar Maurer
92eaec53db docs: add proxmox-backup service description 2021-02-13 09:48:21 +01:00
Dietmar Maurer
b3c2c57897 docs: add services.rst to section sysadmin 2021-02-13 09:40:36 +01:00
Dietmar Maurer
f458e97fda docs: split out output-format.rst 2021-02-13 08:54:23 +01:00
Dietmar Maurer
80bf9ae99b docs: add short descriptions for main binaries. 2021-02-13 08:43:54 +01:00
Dietmar Maurer
bebd4a7ca4 tape: generate proxmox-tape.1 manual page 2021-02-12 18:00:01 +01:00
Dietmar Maurer
9468e94412 tape: add pmt and pmtx command to tape-backup.rst 2021-02-12 17:45:55 +01:00
Dietmar Maurer
6b66c8507f lto-barcode: fix page offset calibration 2021-02-12 13:34:19 +01:00
Dietmar Maurer
167e5406c3 Makefile: fix typo (s/madia-pool/media-pool/) 2021-02-12 12:18:25 +01:00
Dietmar Maurer
c111c9a931 tape: add manual page for tape.cfg 2021-02-12 12:09:08 +01:00