Re: [pve-devel] [PATCH v2 pve-docs 0/6] sdn: Documentation

[Thomas Lamprecht <t.lamprecht@proxmox.com>]

Am 17/11/2023 um 14:55 schrieb Stefan Lendl:
> * Try to homogenize style and format
> * Title case naming conventions for configuration options
> * Simplify examples
> * Re-phrase descriptions
> 
> Changes to v1 -> v2:
> 
> * Split changes per chapter.
> * Use multi-line heading format like in the original file.
>   I used search and replace to "revert" and now the format is identical on all
>   headings.

and never tested even a simple build... just great...

asciidoc: ERROR: .asciidoc-pve-tmp4086737_pvesdn.adoc: line 912: [blockdef-listing] missing closing delimiter
aciidoc error at ./asciidoc-pve line 424.
make[3]: *** [pve-doc-generator.mk:75: chapter-pvesdn.html] Error 1
make[3]: *** Waiting for unfinished jobs....
asciidoc: ERROR: pvesdn.adoc: line 914: [blockdef-listing] missing closing delimiter
make[3]: *** [Makefile:140: pve-admin-guide.pdf] Error 1
asciidoc: ERROR: pvesdn.adoc: line 914: [blockdef-listing] missing closing delimiter
make[3]: *** [Makefile:146: pve-admin-guide.epub] Error 1
asciidoc: ERROR: pvesdn.adoc: line 914: [blockdef-listing] missing closing delimiter

Maybe check the diff and ensuring that the headings stay untouched would
help, the underline aligned with the width of the heading text for a reason..
Or well, a simple build test before sending this, that's the bare minimum that
I expect!

> 
> Stefan Lendl (6):
>   sdn: installation, overview and main configuration
>   sdn: Zones
>   sdn: VNets and Subnets
>   sdn: Controllers
>   sdn: IPAM
>   sdn: Examples
> 

those subjects are borderline useless, there's at least a verb missing.

>  pvesdn.adoc | 906 +++++++++++++++++++++++-----------------------------
>  1 file changed, 402 insertions(+), 504 deletions(-)
>