proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-06-15 05:03:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README.adoc

Browse Source
This commit is contained in:
Dietmar Maurer 2016-04-07 12:53:34 +02:00
parent b4f3c18ad4
commit 0c36e36060
1 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.adoc
View File

@ -2,19 +2,30 @@ Proxmox VE Documentation
======================== ========================
include::attributes.txt[] include::attributes.txt[]
What is this? We try to generate high quality documentation for
------------- http://www.proxmox.com[Proxmox VE], and choose to use
This is an experimental project, trying to generate high quality
documentation for http://www.proxmox.com[Proxmox VE]. We choose to use
http://www.methods.co.nz/asciidoc/[AsciiDoc] as base format. http://www.methods.co.nz/asciidoc/[AsciiDoc] as base format.
One idea is to generate high quality manual pages, and assemble them The basic idea is to generate high quality manual pages, and assemble
into a complete book, called link:pve-admin-guide.adoc[Proxmox VE them into a complete book, called link:pve-admin-guide.adoc[Proxmox VE
Administration Guide]. So we have one source, and generate several Administration Guide]. So we have one source, and generate several
documents from that. It is also possible to generate printable PDF documents from that. It is also possible to generate printable PDF
files, or ebook formats ('.ebup'). 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[] 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 expands to "Proxmox VE". The plan is to add more such definitions for
terms which are used more than once. terms which are used more than once.
NOTE: The github 'asciidoc' viewer does not expand those macros.
Autogenerated CLI Command Synopsis Autogenerated CLI Command Synopsis
---------------------------------- ----------------------------------