Commit Graph

25 Commits

Author SHA1 Message Date
Aaron Lauterer
e5fe7f7cea docs: offline-media: improve read- and understandability
by rephrasing parts to be easier to read or adding more context.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Aaron Lauterer
07fae362b6 docs: offline-keys: improve read- and understandabilty
By rephasing certain parts and splitting long sentences into smaller
ones.

Also changing "licensing server" to "subscription server".

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Aaron Lauterer
a1bae05459 docs: installation: improve read- and understandabilty
This patch contains the larger changes, such as splitting longer
sentences and rewording some parts.

The headline for "Reuse a Proxmox Repository for Offline Mirror Tool"
has been changed to "Set up the Repository on non Proxmox bases
systems". Sounds a bit nicer and we are in the Proxmox Offline Mirror
docs anyway.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Aaron Lauterer
32f3eca628 docs: installation: fix typos, and other small changes
switch from `Proxmox projects` to `Proxmox solutions`.
Add missing words, such as `the` and drop `also`s.

And other small changes that don't affect the actual content or meaning.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Aaron Lauterer
49c845cde5 docs: introduction: rewrite for better readability
splitting long sentences, rephrasing and extending some parts

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Aaron Lauterer
41cb625b6e docs: introduction: fix typos and missing words
adding `the` in a few places, dropping `also`s as they are almost always
just filler words.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2022-09-09 12:38:10 +02:00
Stoiko Ivanov
5d9224ed34 fix typos in command invocation
noted while blindly pasting the output after setting up my first
mirror.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2022-09-08 15:50:52 +02:00
Thomas Lamprecht
624b33a59f docs: drop non-existing APT ref
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 14:12:33 +02:00
Thomas Lamprecht
859c6ebcfa docs: mirror: mention auto-debian-base selection as tip
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:56:09 +02:00
Thomas Lamprecht
ef6ebe79fd docs: intro: reference config file switch/env variable directly
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:39:48 +02:00
Thomas Lamprecht
3d44b696bd docs: ship config manpage as proxmox-offline-mirror.cfg.5
as `mirror.cfg.5` is rather overly generic

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:36:51 +02:00
Thomas Lamprecht
c0c2562e42 docs: intro: add terminology heading
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:04:33 +02:00
Thomas Lamprecht
114497cc4c docs: add installation chapter
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:04:33 +02:00
Thomas Lamprecht
ffbf5b8904 docs: add intro to offline mirrors and media chapters
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:04:33 +02:00
Thomas Lamprecht
dba885fbba docs: restructur/expand offline key chapter
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 13:04:33 +02:00
Thomas Lamprecht
47fd70f0cb docs: mirror: fix --dir in command example
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 11:46:00 +02:00
Thomas Lamprecht
67581096c8 docs: split out chapters into different files
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 11:03:57 +02:00
Thomas Lamprecht
26023cc671 docs: extend, reformat and various small fixes
Fix some left overs from copying this over from PBS, note how to
acquire such a key by contacting sales@proxmox.com, add a paragraph
with some description about what this tool(ing) actually does to the
introduction section, ...

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 08:30:15 +02:00
Thomas Lamprecht
118ab592d3 docs: fix title case and heading markers
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 08:29:39 +02:00
Thomas Lamprecht
e9227093ba docs pdf: avoid extra blank page on section/chapter boundary
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2022-09-08 08:27:52 +02:00
Fabian Grünbichler
1c6fcd3740 docs: make help top-level header
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-06 12:06:13 +02:00
Fabian Grünbichler
e8cc6bb28b docs: expand, improve formatting
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-06 12:06:13 +02:00
Fabian Grünbichler
abaee27150 docs: document key handling
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-06 12:06:13 +02:00
Fabian Grünbichler
e34d988080 remove accidentally committed pycache
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-06 12:06:13 +02:00
Fabian Grünbichler
fabdaf9100 add docs
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-09-06 12:06:13 +02:00