Commit Graph

487 Commits

Author SHA1 Message Date
Maximiliano Sandoval
8237b42885 latex: fix typo in comment
Found with typos-cli (`cargo install typos-cli`):

```
typos --exclude .git --exclude tests --exclude images \
 --exclude changelog
```

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
[S.I.: add typos-cli reference]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-08-08 14:00:06 +02:00
Maximiliano Sandoval
bc08755447 fix typos in documentation
Found with typos-cli (`cargo install typos-cli`):

```
typos --exclude .git --exclude tests --exclude images \
 --exclude changelog
```

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
[S.I.: add typos-cli reference]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-08-08 13:59:12 +02:00
Maximiliano Sandoval
10a1a7b6b6 fix typos in perl and css files
Found with typos-cli (`cargo install typos-cli`):

```
typos --exclude .git --exclude tests --exclude images \
 --exclude changelog
```

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
[S.I.: add typos-cli reference]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-08-08 13:56:52 +02:00
Christoph Heiss
0eadcfcbc2 asciidoc: add clickable anchor link to all headings
Works the same as for our PVE/PBS documentation and is generally common
for documentations.

Very useful for linking specific sections of the documentation in other
places. Previously, this always had to be done by getting the correct
anchor from the HTML directly via e.g. browser devtools.

follows https://git.proxmox.com/?p=pve-docs.git;a=commit;h=ecab5895a4

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
[S.I.: add link to relevant commit in pve-docs]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-08-08 13:56:36 +02:00
Christoph Heiss
ddf3e9f15b installation: fix codeblock rendering in zfs performance tips section
That slipped through, asciidoc uses 4 not 3 dashes for that.

Fixes: c8be3f0 ("installation: align zfs performance tip with PVE documentation")
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-28 19:59:14 +01:00
Thomas Lamprecht
57495cfceb bump version to 8.1.1
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 15:18:15 +01:00
Thomas Lamprecht
8304e86105 update various screenshots
lots of them where made with PMG 6.2, and while we had no huge revamp,
there are quite some small to mid sized changes and improvements all
over the place, so update a few that show such changes and where easy
to regenerate quickly.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 15:18:15 +01:00
Thomas Lamprecht
4c35e536bd installation: reword/expand/reflow and fix login thumbnail
Try to improve the layout, still not really ideal with that many
thumbnails in a single relatively short section but should be a bit
easier to read.

Change the place of the UI login thumbnail as before the numerical
bulletin point list it won't work due to block boundaries and asciidoc

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 14:52:16 +01:00
Thomas Lamprecht
3cb52bcd8d screenshots: update dashboard and login screenshots
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 14:16:16 +01:00
Thomas Lamprecht
6f97245064 screenshots: regenerate installer screenshots with smaller border
to avoid ugly blocking looking images that distract from the actual
content.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 14:15:52 +01:00
Thomas Lamprecht
8bc67ce3c9 verify-images: include the file name that failed verification
so that it might actually be useful..

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 14:15:04 +01:00
Thomas Lamprecht
c07cdc194c buildsys: make verify-images target informative only
The PDF and the HTML are rendered fine anyway, this is just a PITA

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-28 14:14:24 +01:00
Stoiko Ivanov
0091b1c8ae doc-generator: add new option dkim-use-domain
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-28 10:32:38 +01:00
Stoiko Ivanov
b53b522b52 dkim: rephrase signing-domain source docs
mostly to mention the 2 terms RFC5321.MailFrom and RFC5322.From
actually used in the dmarc-rfc for both terms.

additionally rephrase the link phrase from smtp_rfc to rfc_5321 (there
are at least 3 rfcs titled SMTP)

fix 1 small typo.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-28 10:32:38 +01:00
Maximiliano Sandoval
90f38c3de0 dkim: document dkim-use-domain
Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
[S.I.: fix spelling of dkim-use-domain]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-28 10:32:03 +01:00
Thomas Lamprecht
1e9afc1078 bump version to 8.1.0
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-27 17:00:09 +01:00
Thomas Lamprecht
29f6d740c6 update static schema info
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-27 17:00:09 +01:00
Christoph Heiss
38d1451907 asciidoc: make thumbnail path relative to images/
This in turn allows to also use images from other subdirectories, e.g.
`images/installer/`, and not just from `images/screenshot/`.

Replacing all paths was done mechanically using:

  sed -i 's/thumbnail="pmg-gui/thumbnail="screenshot\/pmg-gui/g' *.adoc

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 16:49:18 +01:00
Christoph Heiss
4af6e95585 images: run png-cleanup.pl on all and verify on install
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
9fc9adae61 installation: add a TUI installer screenshot
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
ca47e9efe1 installation: convert installer screenshots to thumbnails
Again, like the PVE documantation. Improves the reading flow quite a bit
too.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
84f2aef40a installation: add nomodeset kernel parameter tip for bogus graphics
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
c8be3f0399 installation: align zfs performance tip with PVE documentation
This one is IMO better worded, so just use that.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
aaec2aab8d installation: update chapter based on PVE docs & new GRUB entries
The new release also brings things such a the serial console
installer and a expandend 'Advanced Options' menu.

This mostly aligns it with the respective documentation from PVE,
rewording some things and adding some {NOTE,TIP,WARNING}s from there as
well.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
6e1ed29673 images: update GRUB menu screenshot to latest release
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Christoph Heiss
522bb4f0ae gitignore: add initial file based on pve-docs
Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
2024-02-27 15:53:49 +01:00
Aaron Lauterer
f43c69832a docs: pmgconfig: fix path to transport file
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2024-02-27 12:08:14 +01:00
Stoiko Ivanov
349ff12ada admin: system-booting: add screenshots
additionally adapt the paths for pmg with:
sed -ri 's/screenshot\///g' system-booting.adoc

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-27 11:54:17 +01:00
Stoiko Ivanov
abe750ed54 admin: include system-booting docs
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-27 11:20:16 +01:00
Stoiko Ivanov
8378a1ebaa admin: system-booting: replace pve with pmg automatically
the result looks correct, and using sed might help in case the
pve-docs get updated:

sed -ri 's/([^-])pve([^.])/\1pmg\2/g;
    /^ifdef::wiki\[\]/,/^endif::wiki\[\]/d' system-booting.adoc

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-27 11:20:12 +01:00
Stoiko Ivanov
93f6b84af6 admin: system-booting: copy system-booting.adoc from pve-docs
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-27 10:29:51 +01:00
Thomas Lamprecht
933d580d69 update static schema info
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-23 18:17:29 +01:00
Thomas Lamprecht
282aa3df32 bump version to 8.0.2
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-22 17:14:30 +01:00
Thomas Lamprecht
f4a381a166 update static schema info
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-22 17:12:33 +01:00
Thomas Lamprecht
98d8fbf4c3 d/copyright: update years
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-22 16:29:55 +01:00
Dominik Csapak
024e41f53e add disclaimer position/separator docs
explain what the default is and that it can be configured.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2024-02-22 16:29:23 +01:00
Thomas Lamprecht
cbd73e8fd4 update static schema info
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2024-02-22 16:18:53 +01:00
Stoiko Ivanov
fc3a8a4593 doc-generator: add new option filter-timeout
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-22 16:15:32 +01:00
Dominik Csapak
dae08541ee rule system: explain new and mode and invert flag
and adding that the previous behaviour is now the default.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2024-02-21 15:39:32 +01:00
Dominik Csapak
e807e3f14c rule system: add a small section about matching rules
this section explains how multiple object categories and multiple
objects interact with the rule matching.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2024-02-20 15:46:43 +01:00
Stoiko Ivanov
dc729b02a5 Fix wrong usage of GiB for disksizes
Fixes: 4b5e4bf098

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-02-13 11:36:15 +01:00
Alexander Zeidler
9163e56afc administration, installation: add chapter "Firmware Updates"
and "Debian Firmware Repository", with mutual linking. Largely
identical to PVE docs, except for:
- remove mentions of ensuring a safe cluster node reboot
- adapt internal links for this doc structure

Firmware updates are important, their existence should not be checked
only when there are already noticeable problems.

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2024-02-13 11:06:35 +01:00
Alexander Zeidler
45613eb153 installation: rephrase section "Other Repository Sources"
to be Debian release independent & conform to additional repo sections

Signed-off-by: Alexander Zeidler <a.zeidler@proxmox.com>
2024-01-22 18:41:19 +01:00
Noel Ullreich
4b5e4bf098 Consistency of GB and GiB pmg
Since the actual system-checks are done in GiB and to stay consistent
with the other docs, change all GB units to GiB

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2024-01-22 18:41:19 +01:00
Noel Ullreich
db96e7429f Fix spelling of command line/command-line
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")

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
[S.I.: fix a stray ' ' introduced with this commit]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-01-22 18:40:37 +01:00
Noel Ullreich
2a039e08c3 Consistency of USB flash drive spelling
To be consistent, replaced all synonyms of USB flash drive (e.g. thumb
drive, drive, stick)

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
2024-01-22 18:28:11 +01:00
Christian Ebner
15dbf33124 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>
2023-08-11 17:23:56 +02:00
Stoiko Ivanov
2a5f1d165e faq: update support table
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2023-07-25 15:13:55 +02:00
Thomas Lamprecht
2b401218fb bump version to 8.0.1
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-06-27 18:22:10 +02:00
Stoiko Ivanov
f6fe502138 run make update
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2023-06-27 14:03:45 +02:00