X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=README.adoc;h=5f2d46421f3c0e0b8784e5c874006e86905c019e;hp=67179cee44bf34989640c059de250ef94af8ea85;hb=f77a3c104e3611ff0d42822a5300a12951b9d78e;hpb=d067c2ad940989c15c5756aa50e9eb2e4f063e1a diff --git a/README.adoc b/README.adoc index 67179ce..5f2d464 100644 --- a/README.adoc +++ b/README.adoc @@ -10,7 +10,7 @@ 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'). +files, or ebook formats ('.epub'). When possible, we provide scripts to extract API definitions, configuration or command line options from the source code. @@ -37,7 +37,7 @@ 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: +those Debian packages using: make deb @@ -82,7 +82,7 @@ below the title text: Level 3: ^^^^^^^^^^^^^^^^^^^^^^ Level 4 (bottom level): ++++++++++++++++++++++ -Section titles should always be preceeded by two empty lines. Each word +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 appear as the first or last word of a title'' (see @@ -128,7 +128,7 @@ Labeled Lists ^^^^^^^^^^^^^ Labeled lists should be used to make lists of key-value style text -more readable, such as command line parameters or config options: +more readable, such as command line parameters or configuration options: .Regular labeled lists ----- @@ -176,11 +176,11 @@ Text and Block Styles * 'Emphasized text': created using \'text', used for emphasizing words and phrases * `Monospaced text`: created using \`text`, used for command / program -names, file paths, inline commands, option names and values +names, file paths, in-line commands, option names and values * *Strong text*: created using \*text*, used for emphasizing concepts or names when first introduced in a section. -There are also different builtin block styles that are used in +There are also different built-in block styles that are used in our documentation: Complete paragraphs can be included literally by prepending each