5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-03-19 18:50:06 +03:00

update README.adoc

This commit is contained in:
Dietmar Maurer 2016-04-07 12:53:34 +02:00
parent b4f3c18ad4
commit 0c36e36060

View File

@ -2,19 +2,30 @@ Proxmox VE Documentation
========================
include::attributes.txt[]
What is this?
-------------
This is an experimental project, trying to generate high quality
documentation for http://www.proxmox.com[Proxmox VE]. We choose to use
We try to generate high quality documentation for
http://www.proxmox.com[Proxmox VE], and choose to use
http://www.methods.co.nz/asciidoc/[AsciiDoc] as base format.
One idea is to generate high quality manual pages, and assemble them
into a complete book, called link:pve-admin-guide.adoc[Proxmox VE
The basic idea is to generate high quality manual pages, and assemble
them into a complete book, called link:pve-admin-guide.adoc[Proxmox VE
Administration Guide]. So we have one source, and generate several
documents from that. It is also possible to generate printable PDF
files, or ebook formats ('.ebup').
When possible, we provide scripts to extract API definitions,
configuration or command line options from the source code.
To simplify the documentation task, we keep all Documentation within
this repository. It is possible to generate the docs (without installing
any additional Proxmox packages) with:
make index.html
We also generate an additional development package called
'pve-doc-generator', which is used by other Proxmox VE package to
generate manual pages at package build time.
Common Macro definition in link:attributes.txt[]
------------------------------------------------
@ -24,8 +35,6 @@ consistency. For example, we defined a macro called `pve`, which
expands to "Proxmox VE". The plan is to add more such definitions for
terms which are used more than once.
NOTE: The github 'asciidoc' viewer does not expand those macros.
Autogenerated CLI Command Synopsis
----------------------------------