Difference between revisions of "Improving the Proxmox VE Documentation"
(Created page with "<!--PVE_IMPORT_START_MARKER--> <!-- Do not edit - this is autogenerated content --> {{#pvedocs:howto-improve-pve-docs-plain.html}} Category:Reference Documentation <pv...") |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
Depending on which issue you want to improve, you can use a variety of | Depending on which issue you want to improve, you can use a variety of | ||
communication mediums to reach the developers. | communication mediums to reach the developers. | ||
| − | If you notice an error in the current documentation, use | + | If you notice an error in the current documentation, use the |
| − | Proxmox bug tracker and propose | + | Proxmox bug tracker and propose an |
alternate text/wording. | alternate text/wording. | ||
If you want to propose new content, it depends on what you want to | If you want to propose new content, it depends on what you want to | ||
| Line 20: | Line 20: | ||
Editing the official documentation requires 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 and then follow the | git://git.proxmox.com/git/pve-docs.git and then follow the | ||
| − | + | README.adoc document. | |
Improving the documentation is just as easy as editing a Wikipedia | Improving the documentation is just as easy as editing a Wikipedia | ||
article and is an interesting foray in the development of a large | article and is an interesting foray in the development of a large | ||
Revision as of 10:07, 16 May 2018
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.
|
If you are interested in working on the Proxmox VE codebase, the Developer Documentation wiki article will show you where to start. |