Proofreading documentation fixes

[kamaki] / docs / installation.rst

diff --git a/docs/installation.rst b/docs/installation.rst
index cc61712..18c0669 100644 (file)
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -36,24 +36,33 @@ With virtualenv users can setup kamaki and synnefo services in a sandbox environ
 .. code-block:: console
 
     $ virtualenv kamaki-env
-
     $ source kamaki-env/bin/activate
 
 A more detailed example of using virtual env can be found at the `snf-image-creator setup guide <http://docs.dev.grnet.gr/snf-image-creator/latest/install.html#python-virtual-environment>`_
 
-2. Install snf-common
-"""""""""""""""""""""
+2. Install objpool (was: snf-common)
+""""""""""""""""""""""""""""""""""""""""""
 
-Package snf-common is part of the synnefo project and is a kamaki dependency since version 0.6.0.
+.. note:: **versions 0.6.0 - 0.6.1**
 
-.. code-block:: console
+    Package snf-common is part of the synnefo project and used to be a kamaki dependency in versions from 0.6.0 to 0.6.1 to provide a connection pooling mechanism. Users who still run 0.6.0 or 0.6.1 may need to manually install the snf-common package:
 
-    $ git clone http://code.grnet.gr/git/synnefo
+    .. code-block:: console
 
-    $ cd synnefo/snf-common
+        $ git clone http://code.grnet.gr/git/synnefo
+        $ cd synnefo/snf-common
+        $ ./setup build install
+        $ cd -
 
-    $ ./setup build install
+**Version 0.6.2 and on:**
+
+Since 0.6.2, kamaki is based on objpool (hence the snf-common dependency is now obsolete). The objpool package is easy to install from source, even on windows platforms:
 
+.. code-block:: console
+
+    $ git clone http://code.grnet.gr/git/objpool
+    $ cd objpool
+    $ ./setup build install
     $ cd -
 
 3. Install kamaki
@@ -62,9 +71,7 @@ Package snf-common is part of the synnefo project and is a kamaki dependency sin
 .. code-block:: console
 
     $ git clone http://code.grnet.gr/git/kamaki
-
     $ cd kamaki
-
     $ ./setup build install
 
 4. Install progress and/or ansicolors (optional)
@@ -77,7 +84,6 @@ ansicolors: color kamaki output (can switched on and off in `setup <setup.html>`
 .. code-block:: console
 
     $ pip install progress
-
     $ pip install ansicolors
 
 Ubuntu and Debian packages
@@ -103,14 +109,24 @@ The following steps describe a command-line approach, but any graphic package ma
 
     $ sudo apt-get update
 
-.. note:: Safely ignore a signature verification error like the following, if it emerges:
+.. note:: Don't forget to get the GPG public key for the GRNET dev team:
+
+    .. code-block:: console
+
+        $ curl https://okeanos.io/files/apt-grnetdev.pub|apt-key add -
 
-    .. warning:: GPG error: http://apt.dev.grnet.gr precise/sid InRelease: The following signatures couldn't be verified because the public key is not available: NO_PUBKEY XXXXXXXX
+    otherwise *apt-get update* will produce GPG warnings.
 
 3. Install kamaki
 """""""""""""""""
 
-Since version 0.6.0, the package snf-common (available at synnefo apt repository) will be automatically installed as a dependency.
+.. note:: **versions 0.6.0 - 0.6.1:**
+
+    The *snf-common* package (available at synnefo apt repository) will be automatically installed as a dependency.
+
+.. note:: **versions 0.6.2 and on:**
+
+    Since version 0.6.2, *objpool* replaces *snf-common*. The objpool package is also available at synnefo repository and is automatically installed as a dependency. The *snf-common* dependency is removed.
 
 .. code-block:: console
 
@@ -122,7 +138,6 @@ Since version 0.6.0, the package snf-common (available at synnefo apt repository
 .. code-block:: console
 
     $ sudo apt-get install python-ansicolors
-
     $ sudo apt-get install python-progress
 
 Mac OS X