projects / pve-docs.git / blame
| Commit | Line | Data |
|---|---|---|
| 22b0b166 DM |
1 | Proxmox VE Documentation |
| 2 | ======================== | |
| 3 | ||
| 4 | What is this? | |
| 5 | ------------- | |
| 6 | ||
| 7 | This is an experimental project, trying to generate high quality | |
| a1ada598 DM |
8 | documentation for http://www.proxmox.com[Proxmox VE]. We choose to use |
| 9 | http://www.methods.co.nz/asciidoc/[AsciiDoc] as base format. | |
| 10 | ||
| 11 | One idea is to generate high quality manual pages, and assemble them | |
| 12 | into a complete book, called link:pve-admin-guide.adoc[Proxmox VE | |
| 13 | Administration Guide]. So we have one source, and generate several | |
| 14 | documents from that. It is also possible to generate printable PDF | |
| 15 | files, or ebook formats ('.ebup'). | |
| 22b0b166 | 16 | |
| 578a3111 DM |
17 | Autogenerated CLI Command Synopsis |
| 18 | ---------------------------------- | |
| 19 | ||
| 20 | We generate the command line synopsis for all manual pages | |
| 21 | automatically. We can do that, because we have a full declarative | |
| 22 | definition of the {pve} API. I added those generated files | |
| 23 | ('*-synopsis.adoc') to the git repository, so that it is possible to | |
| 24 | build the documentation without having a fully installed {pve} | |
| 25 | development environment. | |
| 22b0b166 DM |
26 | |
| 27 | Copyright | |
| 28 | --------- | |
| 29 | ||
| 40152dfd | 30 | Copyright (C) 2016 Proxmox Server Solutions Gmbh |
| 22b0b166 DM |
31 | |
| 32 | Permission is granted to copy, distribute and/or modify this document | |
| 33 | under the terms of the GNU Free Documentation License, Version 1.3 or | |
| 34 | any later version published by the Free Software Foundation; with no | |
| f1e6bbae DM |
35 | Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A |
| 36 | copy of the license is included in the link:LICENSE[LICENSE] file. |