README.adoc

   1 Proxmox VE Documentation
   2 ========================
   3 include::attributes.txt[]
   4
   5 We try to generate high quality documentation for
   6 http://www.proxmox.com[Proxmox VE], and choose to use
   7 http://www.methods.co.nz/asciidoc/[AsciiDoc] as base format.
   8
   9 The basic idea is to generate high quality manual pages, and assemble
  10 them into a complete book, called link:pve-admin-guide.adoc[Proxmox VE
  11 Administration Guide].  So we have one source, and generate several
  12 documents from that. It is also possible to generate printable PDF
  13 files, or ebook formats ('.ebup').
  14
  15 When possible, we provide scripts to extract API definitions,
  16 configuration or command line options from the source code.
  17
  18 To simplify the documentation task, we keep all Documentation within
  19 this repository. It is possible to generate the docs (without installing
  20 any additional Proxmox packages) with:
  21
  22  make index.html
  23
  24 We also generate an additional development package called
  25 'pve-doc-generator', which is used by other Proxmox VE package to
  26 generate manual pages at package build time.
  27
  28
  29 Common Macro definition in link:attributes.txt[]
  30 ------------------------------------------------
  31
  32 'asciidoc' allows us to define common macros, which can then be
  33 referred to using `{macro}`. We try to use this mechanism to improve
  34 consistency. For example, we defined a macro called `pve`, which
  35 expands to "Proxmox VE". The plan is to add more such definitions for
  36 terms which are used more than once.
  37
  38 Autogenerated CLI Command Synopsis
  39 ----------------------------------
  40
  41 We generate the command line synopsis for all manual pages
  42 automatically. We can do that, because we have a full declarative
  43 definition of the {pve} API. I added those generated files
  44 ('*-synopsis.adoc') to the git repository, so that it is possible to
  45 build the documentation without having a fully installed {pve}
  46 development environment.
  47
  48 Copyright
  49 ---------
  50
  51 Copyright (C) 2016 Proxmox Server Solutions Gmbh
  52
  53 Permission is granted to copy, distribute and/or modify this document
  54 under the terms of the GNU Free Documentation License, Version 1.3 or
  55 any later version published by the Free Software Foundation; with no
  56 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
  57 copy of the license is included in the link:LICENSE[LICENSE] file.