[pve-docs.git] / README.adoc

Proxmox VE Documentation
========================
include::attributes.txt[]

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.

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

To update the auto-generate API definitions use:

 make update

NOTE: you need a fully installed development environment for that.


Debian Packages
---------------

We generate a development package called 'pve-doc-generator', which is
used by other Proxmox VE package to generate manual pages at package
build time.

Another package called 'pve-docs' is used to publish generated
'.html' and '.pdf' files on our web servers. You can generate
those debian packages using:

 make deb


Common Macro definition in link:attributes.txt[]
------------------------------------------------

'asciidoc' allows us to define common macros, which can then be
referred to using `{macro}`. We try to use this mechanism to improve
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.

Autogenerated CLI Command Synopsis
----------------------------------

We generate the command line synopsis for all manual pages
automatically. We can do that, because we have a full declarative
definition of the {pve} API. I added those generated files
('*-synopsis.adoc') to the git repository, so that it is possible to
build the documentation without having a fully installed {pve}
development environment.

Copyright
---------

Copyright (C) 2016 Proxmox Server Solutions Gmbh

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the link:LICENSE[LICENSE] file.
Commit	Line	Data
	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
	23
	24	To update the auto-generate API definitions use:
	25
	26	make update
	27
	28	NOTE: you need a fully installed development environment for that.
	29
	30
	31	Debian Packages
	32	---------------
	33
	34	We generate a development package called 'pve-doc-generator', which is
	35	used by other Proxmox VE package to generate manual pages at package
	36	build time.
	37
	38	Another package called 'pve-docs' is used to publish generated
	39	'.html' and '.pdf' files on our web servers. You can generate
	40	those debian packages using:
	41
	42	make deb
	43
	44
	45	Common Macro definition in link:attributes.txt[]
	46	------------------------------------------------
	47
	48	'asciidoc' allows us to define common macros, which can then be
	49	referred to using `{macro}`. We try to use this mechanism to improve
	50	consistency. For example, we defined a macro called `pve`, which
	51	expands to "Proxmox VE". The plan is to add more such definitions for
	52	terms which are used more than once.
	53
	54	Autogenerated CLI Command Synopsis
	55	----------------------------------
	56
	57	We generate the command line synopsis for all manual pages
	58	automatically. We can do that, because we have a full declarative
	59	definition of the {pve} API. I added those generated files
	60	('*-synopsis.adoc') to the git repository, so that it is possible to
	61	build the documentation without having a fully installed {pve}
	62	development environment.
	63
	64	Copyright
	65	---------
	66
	67	Copyright (C) 2016 Proxmox Server Solutions Gmbh
	68
	69	Permission is granted to copy, distribute and/or modify this document
	70	under the terms of the GNU Free Documentation License, Version 1.3 or
	71	any later version published by the Free Software Foundation; with no
	72	Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
	73	copy of the license is included in the link:LICENSE[LICENSE] file.