howto-improve-pve-docs.adoc

   1 [[howto_improve_pve_docs]]
   2 Improving the Proxmox VE Documentation
   3 --------------------------------------
   4 include::attributes.txt[]
   5 ifdef::wiki[]
   6 :pve-toplevel:
   7 endif::wiki[]
   8
   9 Depending on which issue you want to improve, you can use a variety of
  10 communication mediums to reach the developers.
  11
  12 If you notice an error in the current documentation, use the·
  13 http://bugzilla.proxmox.com[Proxmox bug tracker] and propose an·
  14 alternate text/wording.
  15
  16 If you want to propose new content, it depends on what you want to
  17 document:
  18
  19 * if the content is specific to your setup, a wiki article is the best
  20 option. For instance if you want to document specific options for guest
  21 systems, like which combination of Qemu drivers work best with a less popular
  22 OS, this is a perfect fit for a wiki article.
  23
  24 * if you think the content is generic enough to be of interest for all users,
  25 then you should try to get it into the reference documentation. The reference
  26 documentation is written in the easy to use 'asciidoc' document format.
  27 Editing the official documentation requires to clone the git repository at
  28 `git://git.proxmox.com/git/pve-docs.git` and then follow the
  29 https://git.proxmox.com/?p=pve-docs.git;a=blob_plain;f=README.adoc;hb=HEAD[REAME.adoc] document.
  30
  31 Improving the documentation is just as easy as editing a Wikipedia
  32 article and is an interesting foray in the development of a large
  33 opensource project.
  34
  35 NOTE: If you are interested in working on the {pve} codebase, the
  36 {webwiki-url}Developer_Documentation[Developer Documentation] wiki
  37 article will show you where to start.