pvecm: re-add "multiple cluster in same net" section

[pve-docs.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index cda72b0a9bc3a90698ee1c0806e6790935be4c96..cd6642498b3727233ef4ab65867ed7b8d3c4130e 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -18,6 +18,7 @@ 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 pve-doc-generator.mk
  make index
 
 To update the auto-generate API definitions use:
@@ -96,6 +97,10 @@ below the title text:
  Level 3:                 ^^^^^^^^^^^^^^^^^^^^^^
  Level 4 (bottom level):  ++++++++++++++++++++++
 
+NOTE: Level 4 headings are currently not working for `manpage` outputs, you may
+want to use `.SECTION' instead, which results in the same rendering, and this
+level of Heading isn't displayed in any Index/TOC anyway.
+
 Section titles should always be preceded by two empty lines. Each word
 in a title should be capitalized except for ``articles, coordinating
 conjunctions, prepositions, and the word to in infinitives unless they
@@ -138,6 +143,24 @@ Bulleted lists should be created using the '*' symbol:
 * First level again
 
 
+If you need to have other elements on the same level than a list element you
+can do this with the '+' symbol:
+
+----
+. First level
+.. Second level
++
+Anothe Sentence (or Block) on the continued second level.
+. First level again
+----
+
+. First level
+.. Second level
++
+Anothe Sentence (or Block) on the continued second level.
+
+. First level again
+
 Labeled Lists
 ^^^^^^^^^^^^^
 
@@ -266,7 +289,7 @@ will point to this link.
 Screenshots
 -----------
 
-[thumbnail="gui-datacenter-search.png"]
+[thumbnail="screenshot/gui-datacenter-search.png"]
 
 First, it should be noted that we can display screenshots on 'html'
 and 'wiki' pages, and we can include them in printed documentation. But
@@ -276,7 +299,7 @@ depend on the visibility of the screenshot. You can include a
 screenshot by setting the 'thumbnail' attribute on a paragraph:
 
 ----
-[thumbnail="gui-datacenter-search.png"]
+[thumbnail="screenshot/gui-datacenter-search.png"]
 First, it should be noted ...
 ----
 
@@ -301,7 +324,7 @@ all image attributes (from debian package 'imagemagick')
 
 .Default Screenshot Layout
 
-[thumbnail="gui-datacenter-search.png"]
+[thumbnail="screenshot/gui-datacenter-search.png"]
 
 We normally display screenshots as small thumbnail on the right side
 of a paragraph. On printed documentation, we render the full sized
@@ -309,14 +332,14 @@ graphic just before the paragraph, or between the title and the text
 if the paragraph has a title. It is usually a good idea to add a title
 to paragraph with screenshots.
 
-[thumbnail="gui-datacenter-search.png", float="left"]
+[thumbnail="screenshot/gui-datacenter-search.png", float="left"]
 
 If you need to render many screenshots, it is possible to place them
 on the left side, so you can alternate the thumbnail position using the
 `float` attribute:
 
 ----
-[thumbnail="gui-datacenter-search.png", float="left"]
+[thumbnail="screenshot/gui-datacenter-search.png", float="left"]
 If you need to render many screenshots ...
 ----
 
@@ -328,7 +351,7 @@ screenshots create layout problems.
 Copyright
 ---------
 
-Copyright (C) 2016-2017 Proxmox Server Solutions Gmbh
+Copyright (C) 2016-2019 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