Polished phrasing Signed-off-by: Aaron Lauterer <a.laute...@proxmox.com> --- howto-improve-pve-docs.adoc | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-)
diff --git a/howto-improve-pve-docs.adoc b/howto-improve-pve-docs.adoc index c0d277e..41a465c 100644 --- a/howto-improve-pve-docs.adoc +++ b/howto-improve-pve-docs.adoc @@ -5,27 +5,26 @@ ifdef::wiki[] :pve-toplevel: endif::wiki[] -Depending on which issue you want to improve, you can use a variety of -communication mediums to reach the developers. +There are several ways in which the documentation of {pve} and be +improved. -If you notice an error in the current documentation, use the +If you notice an error in the this documentation, please file a bug at http://bugzilla.proxmox.com[Proxmox bug tracker] and propose an alternate text/wording. -If you want to propose new content, it depends on what you want to -document: +For new content to be included in the documentation it depends: -* if the content is specific to your setup, a wiki article is the best -option. For instance if you want to document specific options for guest -systems, like which combination of Qemu drivers work best with a less popular -OS, this is a perfect fit for a wiki article. +* The wiki is a good place when it comes to specific setups. For +example if you want to document options for a specific guest system +or which combination of Qemu drivers work best for a less popular +guest OS. -* if you think the content is generic enough to be of interest for all users, -then you should try to get it into the reference documentation. The reference -documentation is written in the easy to use 'asciidoc' document format. -Editing the official documentation requires to clone the git repository at -`git://git.proxmox.com/git/pve-docs.git` and then follow the -https://git.proxmox.com/?p=pve-docs.git;a=blob_plain;f=README.adoc;hb=HEAD[README.adoc] document. +* The reference documentation if the place for content that is common +enough to be of interest for all users. It is written in the easy to +use asciidoc format. Editing the official documentation requires you +to clone the git repository at `git://git.proxmox.com/git/pve-docs.git` +and then follow the https://git.proxmox.com/?p=pve-docs.git;a=blob_plain;f=README.adoc;hb=HEAD[README.adoc] +document. Improving the documentation is just as easy as editing a Wikipedia article and is an interesting foray in the development of a large -- 2.20.1 _______________________________________________ pve-devel mailing list pve-devel@pve.proxmox.com https://pve.proxmox.com/cgi-bin/mailman/listinfo/pve-devel