Thomas Lamprecht [Tue, 21 Nov 2023 18:19:58 +0000 (19:19 +0100)]
sdn: rework introduction and installation and add support status
Provide installation documentation for opt-in features, document the
current support status, and rework the overview and introduction of
the whole chapter.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Stefan Lendl [Fri, 17 Nov 2023 13:55:26 +0000 (14:55 +0100)]
sdn: overall language and consistency rework
This is a general style polishing rework that wants to:
- improve consistency of spellings and casing
- drop some to verbose examples that included the whole generated
ifupdown2 config, which is not only not that useful here, but will
also get outdated fast, so it is probably more confusing than
helping at the current development pace. Could be nice in some
reduced form some times in a "inner workings" section
- shorten some examples verbosity by not spelling repetitions of
steps, e.g., for those that one needs to apply to all guests in an
example.
Best to check the changes using the following git flags to avoid noise:
git show -w --word-diff=color --word-diff-regex='\w+'
Signed-off-by: Stefan Lendl <s.lendl@proxmox.com>
[ TL: fix build, squash patches to not break patch causality, add
actual commit message and reinstate some notes to avoid loss of
information ] Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Lukas Wagner [Tue, 14 Nov 2023 12:59:54 +0000 (13:59 +0100)]
notifications: update docs to for matcher-based notifications
Target groups and filters have been replaced by notification matchers.
The matcher can match on certain notification properties and route
the notification to a target in case of a match.
This patch updates the docs to reflect these changes.
Stefan Lendl [Fri, 17 Nov 2023 14:40:50 +0000 (15:40 +0100)]
gitignore: add build artefacts and temporary intermediate files
Signed-off-by: Stefan Lendl <s.lendl@proxmox.com>
[ TL: fix subject and use more specific glob ] Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Commandline/command line/command-line where being used interchangeably,
which is not correct
(see: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/command-line).
use command-line when it is an adjective (e.g. "command-line interface")
and use command line when it is a noun (e.g. "change the setting from
the command line")
Friedrich Weber [Thu, 27 Jul 2023 10:37:45 +0000 (12:37 +0200)]
fix #4847: network: extend section on interface naming scheme
Expand the existing section on systemd network interface names with a
link to the systemd.net-naming-scheme(7) manpage and some information
about naming scheme versions. Also mention the possibility of
interface naming changes due to a new naming scheme version, or
kernel/driver updates. This happens for quite some users during the
upgrade from PVE 7 to 8.
Further, describe how to pin a specific naming scheme version and how
to override interface names using systemd.link files.
Also, make some formatting fixes to the existing text.
Signed-off-by: Friedrich Weber <f.weber@proxmox.com>
ceph: rework introduction and recommendation section
Add more headings, update some recommendations to current HW (e.g.,
network and NVMe attached SSD) capabilities and expand recommendations
taking current upstream documentation into account.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Fiona Ebner [Fri, 10 Nov 2023 13:24:45 +0000 (14:24 +0100)]
qm: add section about machine types
expanding from the two currently existing sentences. In the first one, a
typo VMs -> VM's is fixed. In the second one, "one wants to" is changed
to "you want to", because the sentence already starts with "You can" and
it's active voice.
Adds information about the machine version, rationale behind the
defaults for it and what to do for deprecated versions.
Dominik Csapak [Thu, 2 Nov 2023 15:08:23 +0000 (16:08 +0100)]
ui: correct outdated info about entries in the top header
The header part of the gui did change already a few releases ago.
The user name was moved into a menu button, which now contains more
user specific actions.
So, update the section to document the current layout and ui elements
again correctly.
Chapter "Firmware Updates":
* improve the structure and clarity of information provided
* mention which update methods are when available/recommended
* add information about the already pre-installed pve-firmware package
* emphasise the importance of CPU microcode updates, how to interpret
versions and how to recover a possibly unbootable system
* move info about non-free-firmware repo to "Package Repositories"
Chapter "Package Repositories":
* add new section "Debian Firmware Repository"
Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
A little update to the PCI(e) docs. The PCI wiki article has been
reworked as well, in line with changes from this patch.
Along some minor grammar fixes added:
* how to check if kernel modules are being loaded
* how to check which drivers to blacklist
* how to add softdeps for module loading
* where to find kernel params
Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
[ TL: squash in dropping two trailing whitespace errors ] Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Thomas Lamprecht [Mon, 18 Sep 2023 09:53:52 +0000 (11:53 +0200)]
calendar events: fix build for wiki target
This was actually just some POC that got committed by accident and
broke build to to getting a title where not expecting it as there
where two (relatively seen) top-level titles in the calendar events
page.
Fix that by declaring an actual level-0 heading (i.e., title) in the
wiki context.
This then should also fix a dangling link to the calendar-events wiki
page for the docs-in-wiki stuff, e.g., "calendar events" in backup
chapter [0] pointint to 404 [1], that Fiona reported a few weeks ago.
[0]: https://pve.proxmox.com/wiki/Backup_and_Restore#vzdump_jobs
[1]: https://pve.proxmox.com/wiki/Schedule_Format#chapter_calendar_events
Christian Ebner [Fri, 11 Aug 2023 10:43:16 +0000 (12:43 +0200)]
website: update external links to www.proxmox.com
During the redesign of www.proxmox.com the menu structure and therefore
some url changed. Update the external link in order to avoid an
unneccessary redirect.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
They are underdocumented and finding information is not that easy.
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
[TL: break footnote with long link over multiple lines ] Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Thomas Lamprecht [Tue, 25 Jul 2023 08:19:52 +0000 (10:19 +0200)]
user management: add note about case-sensitivity for AD realm
As there its really common to do things case insensitive a docs note
should help users to discover that Proxmox VE allows one to configure
and LDAP/AD realm to also work case insensitive.
While the UI option got added only recently in pve-manager's commit c34c5418 ("ui: active directory realm: expose case-sensitive option")
mention it already, as there's a good chance that manager gets bumped
sooner than docs.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
installation: note that TUI uses same code and use thumbnail attribute
The thumbnail attribute is our preferred way to include those
screenshots, but it requires to be inside a paragraph to be replaced, and
having an admonition directly below the attribute doesn't makes it
part of a paragraph.
So, add a bit of text, which was warranted anyway, allowing us to use
the thumbnail attr again.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
Thomas Lamprecht [Sun, 25 Jun 2023 12:30:08 +0000 (14:30 +0200)]
d/control: ensure docs are build with compatible asciidoc
As commit 5832a54 ("fix running a2x under new package structure") in
the upstream asciidoc-py repo broke overriding the backend with our
own config for the docbook target, which broke our thumbnail
attribute for paragraphs for the PDF output (HTML is done directly by
asciidoc, and there overriding the config still worked).
Reported upstream [0] and workarounded with the proposed fix applied
to an asciidoc package re-build that got uploaded to our devel repo
for bookworm, so ensure that builds are done with a new enough
version.
projects / pve-docs.git / log