pve-docs.git
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

3 years agowhite space cleanups
Dietmar Maurer [Fri, 7 Oct 2016 09:14:20 +0000 (11:14 +0200)]
white space cleanups

3 years agobump version to 4.3-4
Dietmar Maurer [Fri, 7 Oct 2016 08:38:39 +0000 (10:38 +0200)]
bump version to 4.3-4

3 years agoadd pveperf to index.adoc
Dietmar Maurer [Fri, 7 Oct 2016 08:32:47 +0000 (10:32 +0200)]
add pveperf to index.adoc

3 years agoadd pveperf section and man page
Fabian Grünbichler [Fri, 7 Oct 2016 07:58:42 +0000 (09:58 +0200)]
add pveperf section and man page

this is a bit ugly, because pveperf is not an instance of
PVE::CLIHandler - the actual installed man page is still
generated via the pod data contained in
pve-manager/bin/pveperf ...

3 years agopve-docs-mediawiki-import: import new pve-disk-health-monitoring page
Dietmar Maurer [Fri, 7 Oct 2016 08:06:59 +0000 (10:06 +0200)]
pve-docs-mediawiki-import: import new pve-disk-health-monitoring page

3 years agoadd section disk health monitoring to sysadmin chapter
Dominik Csapak [Thu, 6 Oct 2016 13:49:19 +0000 (15:49 +0200)]
add section disk health monitoring to sysadmin chapter

explain that we ship smartmontools, basic usage of smartctl
default behaviour of smartd, and where to get more information

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
3 years agoadd binary names to section titles
Fabian Grünbichler [Thu, 6 Oct 2016 13:01:52 +0000 (15:01 +0200)]
add binary names to section titles

like in the appendix - otherwise this reads really strange,
especially for tools like "pveceph" and "pvesubscription",
where the content is just one sentence, which is not
mentioning the binary at all.

3 years agopct: add section about debug logs via lxc-start
Fabian Grünbichler [Thu, 6 Oct 2016 13:01:50 +0000 (15:01 +0200)]
pct: add section about debug logs via lxc-start

3 years agoadd note about certificate HOWTO
Fabian Grünbichler [Thu, 6 Oct 2016 10:32:13 +0000 (12:32 +0200)]
add note about certificate HOWTO

3 years agocorrect spelling of SYNOPSIS in man pages
Fabian Grünbichler [Thu, 6 Oct 2016 13:12:49 +0000 (15:12 +0200)]
correct spelling of SYNOPSIS in man pages

3 years agocall spell-corrected synopsis generator method
Fabian Grünbichler [Thu, 6 Oct 2016 13:12:48 +0000 (15:12 +0200)]
call spell-corrected synopsis generator method

3 years agoadd helper to correctly resolve links
Dietmar Maurer [Thu, 6 Oct 2016 15:29:03 +0000 (17:29 +0200)]
add helper to correctly resolve links

just a start, not ready to use ...

3 years agoadd block separators to bash commands
Thomas Lamprecht [Wed, 5 Oct 2016 09:57:39 +0000 (11:57 +0200)]
add block separators to bash commands

else a new line is seen as blockend and can break formating

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
3 years agoSeparate cluster node: remove strange sentence
Thomas Lamprecht [Wed, 5 Oct 2016 09:57:38 +0000 (11:57 +0200)]
Separate cluster node: remove strange sentence

It should be clear that the VMs you have now on the node should be those you
want there after the separation.
The sentence is not quite correct and more confusing remove it.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
3 years agoUpdate the list of supported web browsers
Emmanuel Kasper [Wed, 5 Oct 2016 11:16:29 +0000 (13:16 +0200)]
Update the list of supported web browsers

Also move the list of supported browsers from Installing
Proxmox VE to the System Requirements chapter

3 years agomove inheritance section / remove redundant general text
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:56 +0000 (11:48 +0200)]
move inheritance section / remove redundant general text

As inheritance is a property of paths, so it makes sense to
make them a subsection of them.

The permissions paragraph in what used to be a 'terms and
definitions' section now doesn't fit in and is redundant now
that there's a general introduction paragraph.

3 years agomove and expand the Objects and Paths section
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:55 +0000 (11:48 +0200)]
move and expand the Objects and Paths section

It now gets more technical to finish the documentation of
the permission checks found in the API documentation, and is
the final section about the various parts making up the
access control lists.

3 years agoclarify that privileges are always part of roles
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:54 +0000 (11:48 +0200)]
clarify that privileges are always part of roles

3 years agoreorder the roles section
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:53 +0000 (11:48 +0200)]
reorder the roles section

As they provide an overview of predefined roles and give an
idea of what kind of permissions are available, they fit
better right after the new general permission introduction.

3 years agoreplace Terms and Definitions with a general introduction
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:52 +0000 (11:48 +0200)]
replace Terms and Definitions with a general introduction

3 years agoReorder users and groups section above realms section.
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:51 +0000 (11:48 +0200)]
Reorder users and groups section above realms section.

You now first read about users, learning the fact that
they're part of groups and realms, which are described
afterwards.
This seems more natural then starting with realms and then
describing users in a "Terms and Definitions" section.

3 years agoreordering
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:50 +0000 (11:48 +0200)]
reordering

3 years agodocument permission syntax
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:49 +0000 (11:48 +0200)]
document permission syntax

3 years agodescribe two factor authentication
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:48 +0000 (11:48 +0200)]
describe two factor authentication

3 years agoexpand the authentication realm descriptions
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:47 +0000 (11:48 +0200)]
expand the authentication realm descriptions

3 years agoremove first person reference
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:46 +0000 (11:48 +0200)]
remove first person reference

3 years agoremove obsolete note on link local addresses
Wolfgang Bumiller [Wed, 5 Oct 2016 09:48:45 +0000 (11:48 +0200)]
remove obsolete note on link local addresses

3 years agomove system requirements into separate file, move to chapter Installation
Dietmar Maurer [Wed, 5 Oct 2016 08:24:51 +0000 (10:24 +0200)]
move system requirements into separate file, move to chapter Installation

3 years agocleanup: getting-help.adoc is no longer part of sysadmin.adoc
Dietmar Maurer [Wed, 5 Oct 2016 08:06:28 +0000 (10:06 +0200)]
cleanup: getting-help.adoc is no longer part of sysadmin.adoc

3 years agoadd pve-usbstick.adoc, fix mediawiki importer
Dietmar Maurer [Wed, 5 Oct 2016 07:57:47 +0000 (09:57 +0200)]
add pve-usbstick.adoc, fix mediawiki importer

3 years agomove 'Installation' into its own chapter
Dietmar Maurer [Wed, 5 Oct 2016 07:21:24 +0000 (09:21 +0200)]
move 'Installation' into its own chapter

3 years agoremove getting help link from wiki
Dietmar Maurer [Wed, 5 Oct 2016 07:05:10 +0000 (09:05 +0200)]
remove getting help link from wiki

content also moved to other section.

3 years agoadd sections regarding corosync and cluster network
Thomas Lamprecht [Tue, 4 Oct 2016 10:34:13 +0000 (12:34 +0200)]
add sections regarding corosync and cluster network

Describe separate cluster network, the redundant ring protocol, the
requirements for a cluster network and how to edit and trouble shoot the
corosync config

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
3 years agoadd node sparation without re installation section
Thomas Lamprecht [Tue, 4 Oct 2016 10:34:12 +0000 (12:34 +0200)]
add node sparation without re installation section

This gets often questioned in the forum.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
3 years agoadd and use wiki and forum macros
Fabian Grünbichler [Tue, 4 Oct 2016 12:10:24 +0000 (14:10 +0200)]
add and use wiki and forum macros

3 years agoreadme: extend macro section
Fabian Grünbichler [Tue, 4 Oct 2016 12:10:23 +0000 (14:10 +0200)]
readme: extend macro section

3 years agoMerge Bonding form Wiki
Wolfgang Link [Tue, 4 Oct 2016 09:31:35 +0000 (11:31 +0200)]
Merge Bonding form Wiki

3 years agoAdd use case for Bond example
Wolfgang Link [Tue, 4 Oct 2016 09:31:34 +0000 (11:31 +0200)]
Add use case for Bond example

3 years agoinstall/use lvm thin file in pvesm man page
Fabian Grünbichler [Mon, 3 Oct 2016 11:44:10 +0000 (13:44 +0200)]
install/use lvm thin file in pvesm man page

just including it in pvesm.adoc is not enough.

3 years agofurther cleanups in dblatex title page
Dietmar Maurer [Tue, 4 Oct 2016 08:21:23 +0000 (10:21 +0200)]
further cleanups in dblatex title page

3 years agoImprove wording of getting help section for commercial support
Emmanuel Kasper [Mon, 3 Oct 2016 11:45:41 +0000 (13:45 +0200)]
Improve wording of getting help section for commercial support

* list some advantages of the standard support
* put a single link to improve call-to-action

3 years agostyle cleanups
Dietmar Maurer [Tue, 4 Oct 2016 07:35:27 +0000 (09:35 +0200)]
style cleanups

3 years agoAdd sub chapter on how to improve the reference documentation
Emmanuel Kasper [Mon, 3 Oct 2016 11:45:40 +0000 (13:45 +0200)]
Add sub chapter on how to improve the reference documentation

3 years agoMove getting help section from system administration to introduction
Emmanuel Kasper [Mon, 3 Oct 2016 11:45:39 +0000 (13:45 +0200)]
Move getting help section from system administration to introduction

3 years agoExplain Linux Bond and examples
Wolfgang Link [Mon, 3 Oct 2016 08:05:29 +0000 (10:05 +0200)]
Explain Linux Bond and examples

3 years agoZFS RAM usage more precise.
Wolfgang Link [Mon, 3 Oct 2016 07:28:56 +0000 (09:28 +0200)]
ZFS RAM usage more precise.

3 years agoUpdate requirements
Wolfgang Link [Mon, 3 Oct 2016 07:28:55 +0000 (09:28 +0200)]
Update requirements

Make requirement more precise.