[pve-devel] applied-series: [PATCH v4 docs 0/7] Documenation overhaul chapt. 1.12 to 3.2

Aaron Lauterer a.lauterer at proxmox.com
Wed Feb 12 09:45:30 CET 2020



On 2/11/20 5:42 PM, Thomas Lamprecht wrote:
> applied series, but not really happy how you just ignored Stefan's and
> my comment about why you change title capitalization in just a single
> patch (sys requirements one) to something nowhere else used in the docs..

I'm sorry I forgot to answer that. Our current technical writing style 
guide states that first and second level headlines should use title 
capitalization and starting with third level headlines sentence style 
should be used.

We can of course think about changing that, but changing the style guide 
too often will be problematic.

> Fixed that up and made a few general followup patches, renaming the "USB
> flash drive" to "Prepare Installation Media" and re-ordering it before
> "Using the Proxmox VE Installer" which makes quite more sense.
> 
> IMO, a series and months-of-work effort called "overhauling the
> documentation" should also care for such details, i.e., do a step backward
> and see if the general order, flow, .. is all right and somewhat sound.
> As else I'd rather just have "grammar + typo fixes" getting in in continuous
> small patches and see bigger effort on expanding the documentation with new
> content.

This patch series started a long time ago when I was anxious to not 
break anything (e.g. deep links). Therefore restructuring was saved for 
later.



More information about the pve-devel mailing list