pve-docs.git
3 years agoadd external metric server to sysadmin.adoc
Dominik Csapak [Thu, 20 Oct 2016 09:58:33 +0000 (11:58 +0200)]
add external metric server to sysadmin.adoc

this did only exist as a wiki article, but
since we ship with it, this should be in the
reference documentation

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
3 years agoindex.adoc: use Link instead of Donload link
Dietmar Maurer [Thu, 20 Oct 2016 11:23:07 +0000 (13:23 +0200)]
index.adoc: use Link instead of Donload link

3 years agoindex.adoc: auto generate tables with gen-index-includes.pl
Dietmar Maurer [Thu, 20 Oct 2016 11:10:07 +0000 (13:10 +0200)]
index.adoc: auto generate tables with gen-index-includes.pl

3 years agorename Download Link to Link
Dominik Csapak [Thu, 20 Oct 2016 08:19:36 +0000 (10:19 +0200)]
rename Download Link to Link

because apart from the complete guide on the top,
the sites are not intended to be downloaded,
but simply clicked

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
3 years agoAdd reference for onlineHelp for HA resource management
Emmanuel Kasper [Wed, 19 Oct 2016 12:19:40 +0000 (14:19 +0200)]
Add reference for onlineHelp for HA resource management

3 years agobump version to 4.3-11
Dietmar Maurer [Wed, 19 Oct 2016 07:52:48 +0000 (09:52 +0200)]
bump version to 4.3-11

3 years agomediawiki.conf: use <tt> tag for monospace font
Dietmar Maurer [Wed, 19 Oct 2016 07:22:45 +0000 (09:22 +0200)]
mediawiki.conf: use <tt> tag for monospace font

3 years agomediawiki.conf: use <tt> tag for monospace font
Dietmar Maurer [Wed, 19 Oct 2016 07:22:45 +0000 (09:22 +0200)]
mediawiki.conf: use <tt> tag for monospace font

3 years agomediawiki.conf: fix table rendering (use class wikitable)
Dietmar Maurer [Wed, 19 Oct 2016 06:37:11 +0000 (08:37 +0200)]
mediawiki.conf: fix table rendering (use class wikitable)

3 years agomediawiki.conf: simplify footnote rendering (remove <br> tags)
Dietmar Maurer [Wed, 19 Oct 2016 06:28:43 +0000 (08:28 +0200)]
mediawiki.conf: simplify footnote rendering (remove <br> tags)

3 years agomediawiki.conf: add more descriptive comment
Dietmar Maurer [Wed, 19 Oct 2016 06:25:33 +0000 (08:25 +0200)]
mediawiki.conf: add more descriptive comment

3 years agoinstall /etc/asciidoc/mediawiki.conf
Dietmar Maurer [Wed, 19 Oct 2016 06:23:36 +0000 (08:23 +0200)]
install /etc/asciidoc/mediawiki.conf

3 years agoasciidoc-pve.in: use new mediawiki.conf to render wiki pages
Dietmar Maurer [Wed, 19 Oct 2016 06:13:04 +0000 (08:13 +0200)]
asciidoc-pve.in: use new mediawiki.conf to render wiki pages

3 years agomediawiki.conf: use h5 for paragraph titles
Dietmar Maurer [Wed, 19 Oct 2016 06:09:25 +0000 (08:09 +0200)]
mediawiki.conf: use h5 for paragraph titles

3 years agomediawiki.conf: remove gheader/footer content
Dietmar Maurer [Wed, 19 Oct 2016 06:08:00 +0000 (08:08 +0200)]
mediawiki.conf: remove gheader/footer content

simply not required for wiki.

3 years agocopied asciidoc html5 backend from html5.conf to asciidoc/mediawiki.conf
Dietmar Maurer [Wed, 19 Oct 2016 06:03:00 +0000 (08:03 +0200)]
copied asciidoc html5 backend from html5.conf to asciidoc/mediawiki.conf

Because we need to do some minor modification to improve rendering.

3 years agomove asciidoc related data into asciidoc subdir
Dietmar Maurer [Wed, 19 Oct 2016 06:00:33 +0000 (08:00 +0200)]
move asciidoc related data into asciidoc subdir

3 years agouse the html5 backend for asciidoc
Dietmar Maurer [Tue, 18 Oct 2016 11:31:38 +0000 (13:31 +0200)]
use the html5 backend for asciidoc

3 years agouse ADOC_STDARG to compile pve-admin-guide.html
Dietmar Maurer [Tue, 18 Oct 2016 11:16:06 +0000 (13:16 +0200)]
use ADOC_STDARG to compile pve-admin-guide.html

3 years agouse ADOC_STDARG to compile index.html
Dietmar Maurer [Tue, 18 Oct 2016 11:12:15 +0000 (13:12 +0200)]
use ADOC_STDARG to compile index.html

3 years agoMakefile: avoid useless file overwrites - only write changes
Dietmar Maurer [Tue, 18 Oct 2016 10:37:09 +0000 (12:37 +0200)]
Makefile: avoid useless file overwrites - only write changes

3 years agobibliography: add Ceph Cookbook
Fabian Grünbichler [Mon, 17 Oct 2016 11:31:05 +0000 (13:31 +0200)]
bibliography: add Ceph Cookbook

3 years agoAdd subchapter documenting the startup/shutdown options
Emmanuel Kasper [Thu, 13 Oct 2016 12:31:09 +0000 (14:31 +0200)]
Add subchapter documenting the startup/shutdown options

based on http://pve.proxmox.com/wiki/Virtual_Machine_Startup_and_Shutdown_Behavior

3 years agohowto-improve-pve-docs.adoc: moved from pve-intro.adoc
Dietmar Maurer [Tue, 18 Oct 2016 06:18:05 +0000 (08:18 +0200)]
howto-improve-pve-docs.adoc: moved from pve-intro.adoc

And generate a wiki article for this.

3 years agoscan-adoc-refs: fix dependency computation (make it recusive)
Dietmar Maurer [Tue, 18 Oct 2016 05:15:22 +0000 (07:15 +0200)]
scan-adoc-refs: fix dependency computation (make it recusive)

3 years agoMakefile: update - do not delete file pmxcfs.8-synopsis.adoc
Dietmar Maurer [Tue, 18 Oct 2016 05:13:27 +0000 (07:13 +0200)]
Makefile: update -  do not delete file  pmxcfs.8-synopsis.adoc

This is not auto-generated, so we need to keep that file.

3 years agopve-docs-mediawiki-import.in: avoid to add newlines
Dietmar Maurer [Mon, 17 Oct 2016 09:51:43 +0000 (11:51 +0200)]
pve-docs-mediawiki-import.in: avoid to add newlines

3 years agobump version to 4.3-10
Dietmar Maurer [Mon, 17 Oct 2016 08:56:19 +0000 (10:56 +0200)]
bump version to 4.3-10

3 years agopve-docs-mediawiki-import.in: include text version inside pvehide tag
Dietmar Maurer [Mon, 17 Oct 2016 08:35:55 +0000 (10:35 +0200)]
pve-docs-mediawiki-import.in: include text version inside pvehide tag

So that wiki search returns useful content.

3 years agopvedocs-include.php: avoid to use javascript
Dietmar Maurer [Mon, 17 Oct 2016 08:06:39 +0000 (10:06 +0200)]
pvedocs-include.php: avoid to use javascript

Use a ParserAfterTidy hook to avoid JS. This hack was
found in the htmlet tag extension.

3 years agofix typo
Dietmar Maurer [Mon, 17 Oct 2016 08:09:13 +0000 (10:09 +0200)]
fix typo

3 years agopvedocs-include.php: add new mediawiki tag <pvehide>
Dietmar Maurer [Mon, 17 Oct 2016 07:06:43 +0000 (09:06 +0200)]
pvedocs-include.php: add new mediawiki tag <pvehide>

We can use this tag to add content which is not shown
on the final page, but included in the mediawiki search.

3 years agoSigned-off-by: fritz <f.ramberger@proxmox.com>
Friedrich Ramberger [Mon, 17 Oct 2016 04:37:19 +0000 (06:37 +0200)]
Signed-off-by: fritz <f.ramberger@proxmox.com>
3 years agoscan-adoc-refs: skip opts.adoc and synopsis.adoc files
Dietmar Maurer [Sat, 15 Oct 2016 12:40:12 +0000 (14:40 +0200)]
scan-adoc-refs: skip opts.adoc and synopsis.adoc files

3 years agodo not set toplevel attribute for default env
Dietmar Maurer [Sat, 15 Oct 2016 11:04:08 +0000 (13:04 +0200)]
do not set toplevel attribute for default env

3 years agoscan-adoc-refs: cleanup makefile generation
Dietmar Maurer [Sat, 15 Oct 2016 10:38:34 +0000 (12:38 +0200)]
scan-adoc-refs: cleanup makefile generation

3 years agoscan-adoc-refs: sort make targets
Dietmar Maurer [Sat, 15 Oct 2016 09:52:48 +0000 (11:52 +0200)]
scan-adoc-refs: sort make targets

3 years agoscan-adoc-refs: include all sources in MANUAL_SOURCES
Dietmar Maurer [Sat, 15 Oct 2016 09:43:01 +0000 (11:43 +0200)]
scan-adoc-refs: include all sources in MANUAL_SOURCES

3 years agoscan-adoc-refs: use extra loop to compute MAN_SOURCES
Dietmar Maurer [Sat, 15 Oct 2016 08:55:20 +0000 (10:55 +0200)]
scan-adoc-refs: use extra loop to compute MAN_SOURCES

3 years agobump version to 4.3-9
Dietmar Maurer [Fri, 14 Oct 2016 16:32:24 +0000 (18:32 +0200)]
bump version to 4.3-9

3 years agorenamed pmxcfs.8-cli.adoc to pmxcfs.8-synopsis.adoc
Dietmar Maurer [Fri, 14 Oct 2016 11:35:03 +0000 (13:35 +0200)]
renamed pmxcfs.8-cli.adoc to pmxcfs.8-synopsis.adoc

And removed duplicate Makefile rules.

3 years agoqm.conf.adoc: remove empty line between header and attribute
Dietmar Maurer [Fri, 14 Oct 2016 11:11:15 +0000 (13:11 +0200)]
qm.conf.adoc: remove empty line between header and attribute

3 years agoembed autogenerated rules inside pve-doc-generator.mk
Dietmar Maurer [Fri, 14 Oct 2016 11:10:35 +0000 (13:10 +0200)]
embed autogenerated rules inside pve-doc-generator.mk

3 years agoscan-adoc-refs: auto generate dependencies for Makefile
Dietmar Maurer [Fri, 14 Oct 2016 10:26:55 +0000 (12:26 +0200)]
scan-adoc-refs: auto generate dependencies for Makefile

3 years agofix man page titles for section 8
Dietmar Maurer [Fri, 14 Oct 2016 06:51:43 +0000 (08:51 +0200)]
fix man page titles for section 8

3 years agobump version to 4.3-8
Dietmar Maurer [Fri, 14 Oct 2016 06:42:26 +0000 (08:42 +0200)]
bump version to 4.3-8

3 years agopve-docs-mediawiki-import.in: correctly pass category parameter
Dietmar Maurer [Fri, 14 Oct 2016 06:07:15 +0000 (08:07 +0200)]
pve-docs-mediawiki-import.in: correctly pass category parameter

3 years agopve-docs-mediawiki-import.in: simplify code
Dietmar Maurer [Fri, 14 Oct 2016 05:49:26 +0000 (07:49 +0200)]
pve-docs-mediawiki-import.in: simplify code

3 years agoscan-adoc-refs: fix title change via attribute
Dietmar Maurer [Fri, 14 Oct 2016 05:48:29 +0000 (07:48 +0200)]
scan-adoc-refs: fix title change via attribute

3 years agodo not add system-timesync-plain.html to WIKI_IMPORTS
Dietmar Maurer [Fri, 14 Oct 2016 05:27:16 +0000 (07:27 +0200)]
do not add system-timesync-plain.html to WIKI_IMPORTS

This is already inside SYSADMIN_PARTS, so there is no need
to add that twice.

3 years agogenerate wiki page for system-timesync.adoc
Dietmar Maurer [Fri, 14 Oct 2016 05:23:15 +0000 (07:23 +0200)]
generate wiki page for system-timesync.adoc

3 years agogenerate default output file mappings automatically
Dietmar Maurer [Fri, 14 Oct 2016 05:18:04 +0000 (07:18 +0200)]
generate default output file mappings automatically

3 years agogenerate man page output file mappings automatically
Dietmar Maurer [Fri, 14 Oct 2016 04:50:17 +0000 (06:50 +0200)]
generate man page output file mappings automatically

3 years agomark manual pages as toplevel files
Dietmar Maurer [Fri, 14 Oct 2016 04:49:09 +0000 (06:49 +0200)]
mark manual pages as toplevel files

3 years agogenerate wiki output file mappings automatically
Dietmar Maurer [Fri, 14 Oct 2016 04:40:49 +0000 (06:40 +0200)]
generate wiki output file mappings automatically

3 years agouse fixed output file mapping
Dietmar Maurer [Fri, 14 Oct 2016 03:59:05 +0000 (05:59 +0200)]
use fixed output file mapping

3 years agobump version to 4.3-7
Dietmar Maurer [Thu, 13 Oct 2016 09:14:46 +0000 (11:14 +0200)]
bump version to 4.3-7

3 years agofix file names for .5 man pages
Dietmar Maurer [Thu, 13 Oct 2016 09:05:01 +0000 (11:05 +0200)]
fix file names for .5 man pages

3 years agoasciidoc-pve.in: add code to auto generate online help data
Dietmar Maurer [Thu, 13 Oct 2016 08:37:23 +0000 (10:37 +0200)]
asciidoc-pve.in: add code to auto generate online help data

We include that in the extjs code for the GUI.

3 years agouse/define more/better block IDs
Dietmar Maurer [Thu, 13 Oct 2016 06:40:48 +0000 (08:40 +0200)]
use/define more/better block IDs

3 years agosysadmin: add section about NTP configuration
Fabian Grünbichler [Fri, 7 Oct 2016 13:28:31 +0000 (15:28 +0200)]
sysadmin: add section about NTP configuration

based on wiki article Configuration_of_Time_Syncronization_(NTP)

3 years agobump version to 4.3-6
Dietmar Maurer [Wed, 12 Oct 2016 10:38:04 +0000 (12:38 +0200)]
bump version to 4.3-6

3 years agoasciidoc-pve.in: define revdate/revnumber for all backends
Dietmar Maurer [Wed, 12 Oct 2016 09:57:46 +0000 (11:57 +0200)]
asciidoc-pve.in: define revdate/revnumber for all backends

3 years agoasciidoc-pve.in: implement new command print-links-json
Dietmar Maurer [Wed, 12 Oct 2016 09:45:06 +0000 (11:45 +0200)]
asciidoc-pve.in: implement new command print-links-json

prints/stores information about defined blockids with titles/subtitles.
We can use this for the GUI.

3 years agoremove empty line to correctly assign the blockid to the title
Dietmar Maurer [Wed, 12 Oct 2016 09:44:03 +0000 (11:44 +0200)]
remove empty line to correctly assign the blockid to the title

3 years agoscan-adoc-refs: try to associate titles with block IDs
Dietmar Maurer [Wed, 12 Oct 2016 08:45:05 +0000 (10:45 +0200)]
scan-adoc-refs: try to associate titles with block IDs

3 years agoremove test code
Dietmar Maurer [Wed, 12 Oct 2016 09:51:22 +0000 (11:51 +0200)]
remove test code

3 years agopve-firewall.adoc: defined blockids for things we want to reference from GUI
Dietmar Maurer [Wed, 12 Oct 2016 08:41:50 +0000 (10:41 +0200)]
pve-firewall.adoc: defined blockids for things we want to reference from GUI

3 years agorename wiki page from vm.conf to qm.conf
Dietmar Maurer [Wed, 12 Oct 2016 05:11:43 +0000 (07:11 +0200)]
rename wiki page from vm.conf to qm.conf

To be more consistent. I will add a redirect for the old page...

3 years agoremove empty line between heading and attribute definition, fix man titles
Dietmar Maurer [Wed, 12 Oct 2016 04:54:29 +0000 (06:54 +0200)]
remove empty line between heading and attribute definition, fix man titles

To avoid problems with asciidoc.

3 years agouse asciidoc-pve whenever possible
Dietmar Maurer [Wed, 12 Oct 2016 04:35:30 +0000 (06:35 +0200)]
use asciidoc-pve whenever possible

So that we have correct links.

3 years agoasciidoc-pve: be quiet by default
Dietmar Maurer [Tue, 11 Oct 2016 14:53:37 +0000 (16:53 +0200)]
asciidoc-pve: be quiet by default

3 years agoasciidoc-pve: cleanup temporary files
Dietmar Maurer [Tue, 11 Oct 2016 14:48:31 +0000 (16:48 +0200)]
asciidoc-pve: cleanup temporary files

3 years agoMakefile: use full path for asciidoc-pve
Dietmar Maurer [Tue, 11 Oct 2016 14:37:15 +0000 (16:37 +0200)]
Makefile: use full path for asciidoc-pve

3 years agopve-doc-generator: install asciidoc-pve binary
Dietmar Maurer [Tue, 11 Oct 2016 14:28:35 +0000 (16:28 +0200)]
pve-doc-generator: install asciidoc-pve binary

3 years agoMakefile: remove debug code
Dietmar Maurer [Tue, 11 Oct 2016 14:26:05 +0000 (16:26 +0200)]
Makefile: remove debug code

3 years agoasciidoc-pve.in: implement commands to generate man pages
Dietmar Maurer [Tue, 11 Oct 2016 08:28:30 +0000 (10:28 +0200)]
asciidoc-pve.in: implement commands to generate man pages

3 years agofix pve-toplevel attribute for man pages
Dietmar Maurer [Tue, 11 Oct 2016 05:49:48 +0000 (07:49 +0200)]
fix pve-toplevel attribute for man pages

remove empty line to avoid problems with asciidoc.

3 years agoscan-adoc-refs: extract man page section from .adoc file
Dietmar Maurer [Mon, 10 Oct 2016 15:48:44 +0000 (17:48 +0200)]
scan-adoc-refs: extract man page section from .adoc file

3 years agostore manpage section inside .adoc file
Dietmar Maurer [Mon, 10 Oct 2016 15:46:48 +0000 (17:46 +0200)]
store manpage section inside .adoc file

3 years agoscan-adoc-refs: fix chapter links (/pve-docs/chapter-xxx.html)
Dietmar Maurer [Mon, 10 Oct 2016 09:45:52 +0000 (11:45 +0200)]
scan-adoc-refs: fix chapter links (/pve-docs/chapter-xxx.html)

3 years agoasciidoc-pve.in: cleanup for code reuse
Dietmar Maurer [Mon, 10 Oct 2016 08:41:27 +0000 (10:41 +0200)]
asciidoc-pve.in: cleanup for code reuse

3 years agofactor out cleanup method
Dietmar Maurer [Mon, 10 Oct 2016 08:18:56 +0000 (10:18 +0200)]
factor out cleanup method

3 years agonew file pve-docs-mediawiki-import.in
Dietmar Maurer [Mon, 10 Oct 2016 07:14:25 +0000 (09:14 +0200)]
new file pve-docs-mediawiki-import.in

And use auto-generated data from link-refs.json.

Also avoid strange file names.

3 years agoadd correct wiki titles
Dietmar Maurer [Mon, 10 Oct 2016 06:55:17 +0000 (08:55 +0200)]
add correct wiki titles

3 years agoscan-adoc-refs: allow to overwrite title using attribute
Dietmar Maurer [Mon, 10 Oct 2016 06:42:20 +0000 (08:42 +0200)]
scan-adoc-refs: allow to overwrite title using attribute

3 years agoscan-adoc-refs: factor out register_title
Dietmar Maurer [Mon, 10 Oct 2016 06:25:43 +0000 (08:25 +0200)]
scan-adoc-refs: factor out register_title

and try to substitute macros and urls.

3 years agoscan-adoc-refs: improve title parser, store doctype
Dietmar Maurer [Sun, 9 Oct 2016 08:08:50 +0000 (10:08 +0200)]
scan-adoc-refs: improve title parser, store doctype

We store the titel heading level (0 => chapter, 1 => article).

3 years agomake sure we have a text for all xrefs
Dietmar Maurer [Sun, 9 Oct 2016 06:01:49 +0000 (08:01 +0200)]
make sure we have a text for all xrefs

3 years agomark toplevel docs
Dietmar Maurer [Sat, 8 Oct 2016 15:22:48 +0000 (17:22 +0200)]
mark toplevel docs

3 years agoscan-adoc-refs: remove dead code
Dietmar Maurer [Sat, 8 Oct 2016 14:43:31 +0000 (16:43 +0200)]
scan-adoc-refs: remove dead code

3 years agoskip content in pve-admin-guide.adoc for wiki/man environment
Dietmar Maurer [Sat, 8 Oct 2016 14:40:43 +0000 (16:40 +0200)]
skip content in pve-admin-guide.adoc for wiki/man environment

so that scan_adoc_file do not find wrong blockid definitions.

3 years agopve-docs-mediawiki-import: fix syntax error
Dietmar Maurer [Sat, 8 Oct 2016 12:31:41 +0000 (14:31 +0200)]
pve-docs-mediawiki-import: fix syntax error

3 years agosupport xref using <<>> syntax
Dietmar Maurer [Sat, 8 Oct 2016 12:09:45 +0000 (14:09 +0200)]
support xref using <<>> syntax

3 years agosupport reftext for block IDs
Dietmar Maurer [Sat, 8 Oct 2016 11:07:08 +0000 (13:07 +0200)]
support reftext for block IDs

3 years agoscan-adoc-refs: avoid spaces in blockid_target
Dietmar Maurer [Sat, 8 Oct 2016 10:56:22 +0000 (12:56 +0200)]
scan-adoc-refs: avoid spaces in blockid_target

3 years agoscan for bibliography anchors
Dietmar Maurer [Sat, 8 Oct 2016 10:49:20 +0000 (12:49 +0200)]
scan for bibliography anchors

3 years agoasciidoc-pve.in: add some real functionality
Dietmar Maurer [Fri, 7 Oct 2016 10:56:55 +0000 (12:56 +0200)]
asciidoc-pve.in: add some real functionality

3 years agobump version to 4.3-5
Dietmar Maurer [Fri, 7 Oct 2016 09:29:45 +0000 (11:29 +0200)]
bump version to 4.3-5

3 years agoavoid white left border on dblatex title page
Dietmar Maurer [Fri, 7 Oct 2016 09:27:04 +0000 (11:27 +0200)]
avoid white left border on dblatex title page