howto-improve-pve-docs.adoc

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