[pve-devel] [PATCH pve-docs] sdn: update documentation

[Thomas Lamprecht]

Am 13/11/2023 um 16:08 schrieb Stefan Lendl:
> Try to homogenize style and format
> Title case naming conventions for configuration options
> Simplify examples
> Re-phrase descriptions
> 
> Signed-off-by: Stefan Lendl <s.lendl at proxmox.com>
> ---
> 
> Notes:
>     Used single line heading style
>     
>     The multi line heading format just does not work with syntax
>     highlighting in my editor. The generated HTML from adoc is identical.

really? So the next one comes along and switches it something completely
different due to their whatever editor being limited?

I mean we might need to do that conversation for the next major release,
because upstream python implementation of asciidoc wanting to align with
the ruby one in the long term, but I'd rather to so in an explicit commit
and when actually needed, not thrown in with another dozens of different
changes due to some limited editor..


can you please re-send this without above change and having it split in
multiple commits (even if just split per section), to make it easier
to review and digest.

> @@ -1004,16 +873,16 @@ conn input
>      auto=route
>  ----
>  
> -Then generate a pre-shared key with:
> +Generate a pre-shared key with:
>  
>  ----
>  openssl rand -base64 128
>  ----
>  
> -and add the key to `/etc/ipsec.secrets', so that the file contents looks like:
> +and add the key to `/etc/ipsec.secrets`, so that the file contents looks like:
>  
>  ----
> -: PSK <generatedbase64key>
> +#: PSK \<generatedbase64key>

but that disables the config entry, doesn't it?

I'd avoid such changes of adding some # to possible shell output or what not if
there is no clear benefit – here it isn't a shell in the first place so seems
wrong in any way.

>  ----
>  
> -You need to copy the PSK and the configuration onto the other nodes.
> +Copy the PSK and the configuration to all nodes participating in the VXLAN network.