public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>,
	Stefan Lendl <s.lendl@proxmox.com>
Subject: [pve-devel] applied:  [PATCH v2 pve-docs 0/6] sdn: Documentation
Date: Mon, 20 Nov 2023 09:48:38 +0100	[thread overview]
Message-ID: <82ce36c2-7dd2-43ba-949c-03f34c704f66@proxmox.com> (raw)
In-Reply-To: <20231117135531.3198353-1-s.lendl@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.
> 
> Stefan Lendl (6):
>   sdn: installation, overview and main configuration
>   sdn: Zones
>   sdn: VNets and Subnets
>   sdn: Controllers
>   sdn: IPAM
>   sdn: Examples

to avoid more work on my side I now just squashed this with a few fixes, to
make it build and avoid information loss, adding an actual commit message
and some follow-up work (not all pushed out yet).

This could have been handled much nicer, e.g., by doing a commit first that
just adds references, to avoid breaking patch causality w.r.t. build, then
one to fix casings in the various parts that refer to the UI. As going from
the original one to this is naturally a bit work I proposed that a per-section
split could be at least a bit better than all dumped together while not causing
to much work, but per-patch buildabillity (and being to able to build the whole
thing!) is always wanted. Anyhow, what's done is done, please really (!) try to
improve on that for future (docs) patches.




      parent reply	other threads:[~2023-11-20  8:49 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-17 13:55 [pve-devel] " Stefan Lendl
2023-11-17 13:55 ` [pve-devel] [PATCH v2 pve-docs 1/6] sdn: installation, overview and main configuration Stefan Lendl
2023-11-17 13:55 ` [pve-devel] [PATCH v2 pve-docs 2/6] sdn: Zones Stefan Lendl
2023-11-17 13:55 ` [pve-devel] [PATCH v2 pve-docs 3/6] sdn: VNets and Subnets Stefan Lendl
2023-11-17 13:55 ` [pve-devel] [PATCH v2 pve-docs 4/6] sdn: Controllers Stefan Lendl
2023-11-17 13:55 ` [pve-devel] [PATCH v2 pve-docs 5/6] sdn: IPAM Stefan Lendl
2023-11-17 13:55 ` [pve-devel] [PATCH v2 pve-docs 6/6] sdn: Examples Stefan Lendl
2023-11-18 16:51 ` [pve-devel] [PATCH v2 pve-docs 0/6] sdn: Documentation Thomas Lamprecht
2023-11-20  8:48 ` Thomas Lamprecht [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=82ce36c2-7dd2-43ba-949c-03f34c704f66@proxmox.com \
    --to=t.lamprecht@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    --cc=s.lendl@proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal