zfs: fix typo
[pve-docs.git] / howto-improve-pve-docs.adoc
1 [[howto_improve_pve_docs]]
2 Improving the {pve} Documentation
3 ---------------------------------
4 ifdef::wiki[]
5 :pve-toplevel:
6 endif::wiki[]
7
8 Contributions and improvements to the {pve} documentation are always welcome.
9 There are several ways to contribute.
10
11 If you find errors or other room for improvement in this documentation, please
12 file a bug at the https://bugzilla.proxmox.com/[Proxmox bug tracker] to propose
13 a correction.
14
15 If you want to propose new content, choose one of the following options:
16
17 * The wiki: For specific setups, how-to guides, or tutorials the wiki   is the
18 right option to contribute.
19
20 * The reference documentation: For general content that will be   helpful to all
21   users please propose your contribution for the   reference documentation. This
22   includes all information about how to install, configure, use, and
23   troubleshoot {pve} features. The reference documentation is written in the
24   https://en.wikipedia.org/wiki/AsciiDoc[asciidoc format]. To edit the
25   documentation you need to clone the git repository at
26   `git://git.proxmox.com/git/pve-docs.git`; then follow the
27   https://git.proxmox.com/?p=pve-docs.git;a=blob_plain;f=README.adoc;hb=HEAD[README.adoc]
28   document.
29
30 NOTE: If you are interested in working on the {pve} codebase, the
31 {webwiki-url}Developer_Documentation[Developer Documentation] wiki article will
32 show you where to start.