Commit Graph

1986 Commits

Author SHA1 Message Date
Christoph Heiss
fcbe9ac485 getting-help: forum: align wording with pmg-docs
This paragraph as phrased in pmg-docs sounds better & reads easier, so
apply it here too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-03-06 18:15:55 +01:00
Christoph Heiss
08556a1d91 local-btrfs: unify casing for btrfs
It's mostly spelled BTRFS anyway in our documentation (and also the
official casing AFAICS), so align a few instances where it spelled
lowercase.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-03-06 18:15:35 +01:00
Christoph Heiss
ef466ec91a asciidoc: introduce pricing-url variable, much like pmg-docs
Seems like a pretty sensible thing to do here too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-03-06 18:15:30 +01:00
Christoph Heiss
f9a0c435e2 gitignore: add package build outputs
.. much like it many other repos.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-03-06 18:15:19 +01:00
Dominik Csapak
2c462964df storage: fix zfs over iscsi links
The `_ZFS_over_iSCSI` wiki page is redirected to the legacy page
(for historical reasons), but we want to link to the reference docs
instead.

for the wiki add the legacy link in a `see also` section, so users can
still reach that page easily should they need to

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2024-03-06 18:14:23 +01:00
Thomas Lamprecht
c2eab5cc87 docbook: render 4th section level for manpages
In the manpage output the sections get rendered as refsections, but
those only go up to level 3:

> In DocBook, RefSect3 is the lowest-level section allowed in a
> RefEntry. There is no element analogous to a Sect4.
-- https://tdg.docbook.org/tdg/4.5/refsect3

While nesting refsect3 would work output wise, the DTD schema does not
allows this, and disabling schema validation can lead to graver
issues, so rather avoid that and use a formalpara [0], a paragraph
with a title, instead, but only for the title, as the inner content
will be a simpara (simple paragraph) that cannot be nested inside a
formalpara, but the resulting rendering works out well enough.

[0]: https://tdg.docbook.org/tdg/4.5/formalpara

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-06 18:09:56 +01:00
Thomas Lamprecht
4a06054e39 doc-generator: ship our pve-docbook config and use it for manpages
so that it can also be used when generating per-package docs like
manpages.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-06 17:59:56 +01:00
Thomas Lamprecht
a0fdba3295 css: fine-tune h4, h5, h6 headings font-sizes
Else h6 was quite a bit tinier than the actual paragraph text, and it
doesn't hurts that h4 stands a bit out more.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-06 17:59:31 +01:00
Thomas Lamprecht
450dc469d9 correctly render level 5 headings
E.g., render them as h6 for the HTML output.

Level 5 headings are the +++++ ones in the full page output, in the
per-chapter outputs they are level 4 and worked fine already.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-06 17:59:31 +01:00
Thomas Lamprecht
7409fad4db dblatex: update custom style with upstream changes
checked with:
diff -up /etc/asciidoc/dblatex/asciidoc-dblatex.sty asciidoc/dblatex-custom.sty

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-03-06 17:59:31 +01:00
Lukas Wagner
dd5a4927e7 vzdump: remove usage examples involving 'notification-{target, policy}'
Also clarify in one example that using `--mailto` will bypass the
notification system (at least from the user's perspective).

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2024-02-20 16:15:02 +01:00
Fabian Grünbichler
508a36f599 partially fix #5139: document qnetd port requirement
we could also add a check somewhere in pve-cluster for this.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
 [ TL: squash in changes Fiona proposed for the port syntax/wording ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-20 16:00:25 +01:00
Fabian Grünbichler
f358b68663 fix #5140: qdevice SSH access documentation
rephrase in order to not make it seem like password-based access is required.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2024-02-20 15:55:05 +01:00
Christoph Heiss
7c73a2099c tree-wide: unify spelling of GRUB and systemd-boot
Especially for GRUB there were a myriad of different casing variants
(e.g. grub, Grub, GRUB), so unify them, with GRUB being the official
casing.

For systemd-boot, fix an instance where it was not typeset as
monospace, like everywhere else.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-20 15:45:16 +01:00
Christoph Heiss
83a43f6ee8 installation: add section about booting with nomodeset
As the grub entry specific to this was removed with the 8.1 release, add
a separate section for this to link users too.

Unfortunaly it is relatively often needed, due to very old or very new
hardware, or when Nvidia cards are installed.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-20 15:45:16 +01:00
Christoph Heiss
b0e1acde66 installation: add note about memtest86+ incompatibility with secureboot
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-20 15:45:16 +01:00
Christoph Heiss
fb5a7129ca screenshots: update grub menu screenshot
The 8.1 release changed some things, so update the screenshot to keep in
sync with the latest ISO.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-20 15:44:26 +01:00
Thomas Lamprecht
af47d42e31 qm: resource limits: reword affinity section
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-20 13:34:47 +01:00
Thomas Lamprecht
0186a4671a qm: resource limits: reword cpulimit section
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-20 13:28:46 +01:00
Alexander Zeidler
b3848f246c qm: resource limits: revise section affinity
* mention side effects
* increase compactness w/o complexity
* improve section-formatting

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2024-02-20 13:01:23 +01:00
Alexander Zeidler
6a31c01b5a qm: resource limits: revise section cpuunits
* restructure sentences minimally
* improve section-formatting

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2024-02-20 13:01:23 +01:00
Alexander Zeidler
d17b6bd3d5 qm: resource limits: revise section cpulimit
* precise statements
* increase compactness w/o complexity
* improve section-formatting

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2024-02-20 13:01:23 +01:00
Alexander Zeidler
0554c751fd pvecm: correct network address
Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2024-02-20 13:00:36 +01:00
Alexander Zeidler
c3ff28327c ballooning: precise example
Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2024-02-20 12:58:59 +01:00
Hannes Duerr
bf7e21c929 firewall: fix link to suricata page
Signed-off-by: Hannes Duerr <h.duerr@proxmox.com>
2024-02-19 14:29:59 +01:00
Christoph Heiss
6452603e32 installation: update installer option wording & description
Some things changed with the 8.1 release, so update all the relevant
things here too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-06 15:29:58 +01:00
Fiona Ebner
7475d2c15f storage: lvm: mention how saferemove setting is called in the UI
to avoid confusion.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-02-02 17:14:09 +01:00
Fiona Ebner
8c60c6e43b storage: improve description of 'shared' property
Following pve-storage commit 4abb327 ("plugin schema: improve
description of 'shared' property"), adapting the description also
here in the documentation.

It's not clear to users what this property does otherwise.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-02-01 09:44:53 +01:00
Fiona Ebner
9cfbea5361 pvecm: remove node: explain how to deal with the node's pmxcfs directory
Reported in the community forum:
https://forum.proxmox.com/threads/139006/post-621739

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-01-15 17:49:16 +01:00
Christian Ebner
4a6bd57a54 notifications: fix typos and improve reading flow
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2024-01-10 15:54:17 +01:00
Fiona Ebner
8f40162150 storage: lvm: expand on description of saferemove option
mentioning why zeroing-out might be necessary.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
2024-01-09 10:38:04 +01:00
Aaron Lauterer
8182a38ecf local-zfs: use correct man page for vdev infos
ZFS did split up their man pages a while ago

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-01-05 10:28:51 +01:00
Aaron Lauterer
ba79133d24 qm-cloud-init: make install inside VM more obvious
by making that part bold. While there is already a big note where
cloudinit needs to be installed, it is after the actual command.

Making it more obvious right before the command will hopefully reduce
confusion for more users.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-01-03 12:04:21 +01:00
Fabian Grünbichler
2a249c843d fix 'vpus' typo
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-12-22 10:35:18 +01:00
Lukas Wagner
3f85bfe005 fix #5089: pvesdn: replace quest(s) -> guest(s)
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
2023-11-29 16:24:58 +01:00
Fabian Grünbichler
5afa9371b0 fix #5087: qm: formatting of start/shutdown order list
drop the stray '*' and reflow.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-11-29 14:41:22 +01:00
Alexander Zeidler
3a175eaa3b installation: be more specific about current secure boot state
Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2023-11-28 16:17:40 +01:00
Alexander Zeidler
c1ffc4588a secure boot: fix typos, add inline code formatting
Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2023-11-28 16:17:40 +01:00
Thomas Lamprecht
ea5fbb91ef bump version to 8.1.3
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-23 10:51:01 +01:00
Thomas Lamprecht
4235b3f913 system booting: fixup title-case
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-23 10:49:53 +01:00
Fabian Grünbichler
22f9f3e495 secure boot: add subsection for DKMS/MOK
similar, but a bit more beginner friendly compared to the wiki article.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2023-11-23 10:48:59 +01:00
Christoph Heiss
263533e40f system-booting: fix typo
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2023-11-23 09:48:10 +01:00
Christoph Heiss
a1b7779701 system-booting: add note about weird uefi behaviour
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2023-11-22 19:05:20 +01:00
Thomas Lamprecht
b2832b3e25 bump version to 8.1.2
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-22 19:03:38 +01:00
Thomas Lamprecht
5cea6ab123 system booting: use title-case for secboot-switch section
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-22 18:28:18 +01:00
Christoph Heiss
bb94283b8c system-booting: add instructions to switch install to secure boot
As this procedure could *potentially* lead to data loss (however
unlikely if followed correctly), put a big warning on top, for safety.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2023-11-22 18:21:04 +01:00
Christian Ebner
0f2a9dceae pvesdn: Fix heading for NetBox IPAM plugin section
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2023-11-22 15:11:33 +01:00
Thomas Lamprecht
35c274bf8a bump version to 8.1.1
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-22 15:03:14 +01:00
Thomas Lamprecht
a5a80fe8cc update static/schema information
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-11-22 15:02:13 +01:00
Christian Ebner
a823e409ef pvesdn: remove double occurrence of 'external'
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2023-11-22 14:56:36 +01:00