proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-04-29 20:02:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Overhaul How To Improve Docs

Browse Source 
general overhauling, improve phrasing

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
This commit is contained in:
Aaron Lauterer 2020-02-05 15:16:58 +01:00 committed by Thomas Lamprecht
parent 6bce99cb35
commit 6c70760276
1 changed files with 17 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
howto-improve-pve-docs.adoc
View File

@ -5,31 +5,27 @@ ifdef::wiki[]
:pve-toplevel: :pve-toplevel:
endif::wiki[] endif::wiki[]
Depending on which issue you want to improve, you can use a variety of Contributions and improvements to the {pve} 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
http://bugzilla.proxmox.com[Proxmox bug tracker] and propose an file a bug at the https://bugzilla.proxmox.com/[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:
* if the content is specific to your setup, a wiki article is the best * The wiki: For specific setups, how-to guides, or tutorials the wiki is the
option. For instance if you want to document specific options for guest right option to contribute.
systems, like which combination of Qemu drivers work best with a less popular
OS, this is a perfect fit for a wiki article.
* if you think the content is generic enough to be of interest for all users, * The reference documentation: For general content that will be helpful to all
then you should try to get it into the reference documentation. The reference users please propose your contribution for the reference documentation. This
documentation is written in the easy to use 'asciidoc' document format. includes all information about how to install, configure, use, and
Editing the official documentation requires to clone the git repository at troubleshoot {pve} features. The reference documentation is written in the
`git://git.proxmox.com/git/pve-docs.git` and then follow the https://en.wikipedia.org/wiki/AsciiDoc[asciidoc format]. To edit the
https://git.proxmox.com/?p=pve-docs.git;a=blob_plain;f=README.adoc;hb=HEAD[README.adoc] document. documentation you need to clone the git repository at
`git://git.proxmox.com/git/pve-docs.git`; then follow the
Improving the documentation is just as easy as editing a Wikipedia https://git.proxmox.com/?p=pve-docs.git;a=blob_plain;f=README.adoc;hb=HEAD[README.adoc]
article and is an interesting foray in the development of a large document.
opensource project.
NOTE: If you are interested in working on the {pve} codebase, the NOTE: If you are interested in working on the {pve} codebase, the
{webwiki-url}Developer_Documentation[Developer Documentation] wiki {webwiki-url}Developer_Documentation[Developer Documentation] wiki