]> git.proxmox.com Git - pve-docs.git/blobdiff - pve-intro.adoc
Add sub chapter on how to improve the reference documentation
[pve-docs.git] / pve-intro.adoc
index fab3585be8216fa053b97829f9d5733e7fe895af..0431e09a0b86b3b2b93fcefc7746c210a900444f 100644 (file)
@@ -9,7 +9,7 @@ Kernel-based Virtual Machine (KVM) and container-based virtualization
 
 One main design goal was to make administration as easy as
 possible. You can use {pve} on a single node, or assemble a cluster of
-many nodes. All management task can be done using our web-based
+many nodes. All management tasks can be done using our web-based
 management interface, and even a novice user can setup and install
 {pve} within minutes.
 
@@ -23,13 +23,13 @@ While many people start with a single node, {pve} can scale out to a
 large set of clustered nodes. The cluster stack is fully integrated
 and ships with the default installation.
 
-Unique Multi-master Design::
+Unique Multi-Master Design::
 
 The integrated web-based management interface gives you a clean
 overview of all your KVM guests and Linux containers and even of your
 whole cluster. You can easily manage your VMs and containers, storage
 or cluster from the GUI. There is no need to install a separate,
-complex, and pricy management server.
+complex, and pricey management server.
 
 Proxmox Cluster File System (pmxcfs)::
 
@@ -48,7 +48,7 @@ cluster file system.
 Web-based Management Interface::
 
 Proxmox VE is simple to use. Management tasks can be done via the
-included web based managment interface - there is no need to install a
+included web based management interface - there is no need to install a
 separate management tool or any additional management node with huge
 databases. The multi-master tool allows you to manage your whole
 cluster from any node of your cluster. The central web-based
@@ -74,7 +74,7 @@ hosting environments.
 
 Role-based Administration::
 
-You can define granular access for all objects (like VM´s, storages,
+You can define granular access for all objects (like VMs, storages,
 nodes, etc.) by using the role based user- and permission
 management. This allows you to define privileges and helps you to
 control access to objects. This concept is also known as access
@@ -88,7 +88,7 @@ Active Directory, LDAP, Linux PAM standard authentication or the
 built-in Proxmox VE authentication server.
 
 
-Flexible Storage 
+Flexible Storage
 ----------------
 
 The Proxmox VE storage model is very flexible. Virtual machine images
@@ -116,6 +116,7 @@ Local storage types supported are:
 * Directory (storage on existing filesystem)
 * ZFS
 
+
 Integrated Backup and Restore
 -----------------------------
 
@@ -128,6 +129,7 @@ NFS, iSCSI LUN, Ceph RBD or Sheepdog. The new backup format is
 optimized for storing VM backups fast and effective (sparse files, out
 of order data, minimized I/O).
 
+
 High Availability Cluster
 -------------------------
 
@@ -136,6 +138,7 @@ available virtual servers. The Proxmox VE HA Cluster is based on
 proven Linux HA technologies, providing stable and reliable HA
 services.
 
+
 Flexible Networking
 -------------------
 
@@ -154,7 +157,7 @@ leveraging the full power of the Linux network stack.
 Integrated Firewall
 -------------------
 
-The intergrated firewall allows you to filter network packets on
+The integrated firewall allows you to filter network packets on
 any VM or Container interface. Common sets of firewall rules can
 be grouped into ``security groups''.
 
@@ -179,6 +182,7 @@ the product always meets professional quality criteria.
 Open source software also helps to keep your costs low and makes your
 core infrastructure independent from a single vendor.
 
+
 Your benefit with {pve}
 -----------------------
 
@@ -191,11 +195,14 @@ Your benefit with {pve}
 * Huge active community
 * Low administration costs and simple deployment
 
+include::getting-help.adoc[]
+
+
 Project History
 ---------------
 
 The project started in 2007, followed by a first stable version in
-2008. By that time we used OpenVZ for containers, and KVM for virtual
+2008. At the time we used OpenVZ for containers, and KVM for virtual
 machines. The clustering features were limited, and the user interface
 was simple (server generated web page).
 
@@ -207,8 +214,8 @@ the user. Managing a cluster of 16 nodes is as simple as managing a
 single node.
 
 We also introduced a new REST API, with a complete declarative
-spezification written in JSON-Schema. This enabled other people to
-integrate {pve} into their infrastructur, and made it easy provide
+specification written in JSON-Schema. This enabled other people to
+integrate {pve} into their infrastructure, and made it easy to provide
 additional services.
 
 Also, the new REST API made it possible to replace the original user
@@ -225,7 +232,7 @@ are extremely cost effective.
 
 When we started we were among the first companies providing
 commercial support for KVM. The KVM project itself continuously
-evolved, and is now a widely used hypervisor. New features arrives
+evolved, and is now a widely used hypervisor. New features arrive
 with each release. We developed the KVM live backup feature, which
 makes it possible to create snapshot backups on any storage type.
 
@@ -233,3 +240,36 @@ The most notable change with version 4.0 was the move from OpenVZ to
 https://linuxcontainers.org/[LXC]. Containers are now deeply
 integrated, and they can use the same storage and network features
 as virtual machines.
+
+Improving the {pve} documentation
+---------------------------------
+
+Depending on which issue you want to improve, you can use a variety of
+communication mediums to reach the developers.
+
+If you notice an error in the current documentation, use the·
+http://bugzilla.proxmox.com[Proxmox bug tracker] and propose an·
+alternate text/wording.
+
+If you want to propose new content, it depends on what you want to
+document:
+
+* if the content is specific to your setup, a wiki article is the best
+option. For instance if you want to document specific options for guest
+systems, like which combination of Qemu drivers work best with a less popular
+OS, this is a perfect fit for a wiki article.
+
+* if you think the content is generic enough to be of interest for all users,
+then you should try to get it in the reference documentation. The reference
+documentation is written in the easy to use asciidoc document format. 
+Editing the official documentation requires to clone the git repository at
+`git://git.proxmox.com/git/pve-docs.git` and then follow the 
+https://git.proxmox.com/?p=pve-docs.git;a=blob_plain;f=README.adoc;hb=HEAD[REAME.adoc] document.
+
+Improving the documentation is just as easy as editing a Wikipedia
+article and is an interesting foray in the development of a large
+opensource project.
+
+NOTE: If you are interested in working on the {pve} codebase, the
+https://pve.proxmox.com/wiki/Developer_Documentation[Developer
+Documentation] wiki article will show you where to start.