Difference between revisions of "Improving the Proxmox VE Documentation"

From Proxmox VE
Jump to: navigation, search
 
Line 4: Line 4:
 
[[Category:Reference Documentation]]
 
[[Category:Reference Documentation]]
 
<pvehide>
 
<pvehide>
Depending on which issue you want to improve, you can use a variety of
+
Contributions and improvements to the Proxmox VE documentation are always welcome.
communication mediums to reach the developers.
+
There are several ways to contribute.
If you notice an error in the current documentation, use the
+
If you find errors or other room for improvement in this documentation, please
Proxmox bug tracker and propose an
+
file a bug at the Proxmox bug tracker to propose
alternate text/wording.
+
a correction.
If you want to propose new content, it depends on what you want to
+
If you want to propose new content, choose one of the following options:
document:
+
The wiki: For specific setups, how-to guides, or tutorials the wiki   is the
if the content is specific to your setup, a wiki article is the best
+
right option to contribute.
option. For instance if you want to document specific options for guest
+
The reference documentation: For general content that will be  helpful to all
systems, like which combination of Qemu drivers work best with a less popular
+
  users please propose your contribution for the  reference documentation. This
OS, this is a perfect fit for a wiki article.
+
  includes all information about how to install, configure, use, and
if you think the content is generic enough to be of interest for all users,
+
  troubleshoot Proxmox VE features. The reference documentation is written in the
then you should try to get it into the reference documentation. The reference
+
  asciidoc format. To edit the
documentation is written in the easy to use asciidoc document format.
+
  documentation you need to clone the git repository at
Editing the official documentation requires to clone the git repository at
+
  git://git.proxmox.com/git/pve-docs.git; then follow the
git://git.proxmox.com/git/pve-docs.git and then follow the
+
  README.adoc
README.adoc document.
+
  document.
Improving the documentation is just as easy as editing a Wikipedia
 
article and is an interesting foray in the development of a large
 
opensource project.
 
 
If you are interested in working on the Proxmox VE codebase, the
 
If you are interested in working on the Proxmox VE codebase, the
Developer Documentation wiki
+
Developer Documentation wiki article will
article will show you where to start.
+
show you where to start.
 
</pvehide>
 
</pvehide>
 
<!--PVE_IMPORT_END_MARKER-->
 
<!--PVE_IMPORT_END_MARKER-->

Latest revision as of 18:25, 13 February 2020

Contributions and improvements to the Proxmox VE documentation are always welcome. There are several ways to contribute.

If you find errors or other room for improvement in this documentation, please file a bug at the Proxmox bug tracker to propose a correction.

If you want to propose new content, choose one of the following options:

  • The wiki: For specific setups, how-to guides, or tutorials the wiki is the right option to contribute.

  • The reference documentation: For general content that will be helpful to all users please propose your contribution for the reference documentation. This includes all information about how to install, configure, use, and troubleshoot Proxmox VE features. The reference documentation is written in the asciidoc format. To edit the documentation you need to clone the git repository at git://git.proxmox.com/git/pve-docs.git; then follow the README.adoc document.

Note If you are interested in working on the Proxmox VE codebase, the Developer Documentation wiki article will show you where to start.