You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

howto-improve-pve-docs.adoc 1.5KB

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