Make numerous minor fixes in documentation

[kamaki] / docs / installation.rst

diff --git a/docs/installation.rst b/docs/installation.rst
index b7d7a4f..4c6f5e9 100644 (file)
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -4,7 +4,7 @@ Installation
 This guide describes the standard installation process for kamaki, with the
 aspiration of covering as much cases as possible. Although kamaki was initially
 targeted to Linux/Unix-like users, it is quite straightforward to install and
 This guide describes the standard installation process for kamaki, with the
 aspiration of covering as much cases as possible. Although kamaki was initially
 targeted to Linux/Unix-like users, it is quite straightforward to install and

-have it up and running in all platforms running python 2.6 or 2.7.
+have it up and running in all platforms running Python 2.6 or 2.7.

 
 
 * Kamaki repository: `http://code.grnet.gr/git/kamaki <http://code.grnet.gr/git/kamaki>`_
 
 
 * Kamaki repository: `http://code.grnet.gr/git/kamaki <http://code.grnet.gr/git/kamaki>`_

@@ -13,8 +13,8 @@ have it up and running in all platforms running python 2.6 or 2.7.
 
 * Synnefo Linux packages: `http://apt.dev.grnet.gr <http://apt.dev.grnet.gr>`_
 
 
 * Synnefo Linux packages: `http://apt.dev.grnet.gr <http://apt.dev.grnet.gr>`_
 

-Linux and Unix-like enviroments
--------------------------------
+Linux and Unix-like environments
+--------------------------------

 
 Debian:
 ^^^^^^^
 
 Debian:
 ^^^^^^^

@@ -50,7 +50,8 @@ The following steps describe a command-line approach, but any graphic package ma
 Ubuntu
 ^^^^^^
 
 Ubuntu
 ^^^^^^
 

-The following steps describe a command-line approach, but any graphic package manager can be used instead.
+The following steps describe a command-line approach, but any graphic package
+manager can be used instead.

 
 * Let ppa take care of the repository configuration:
 
 
 * Let ppa take care of the repository configuration:
 

@@ -89,6 +90,32 @@ Install mock (for developers only)
 
     $ sudo apt-get install python-mock=1.0.1
 
 
     $ sudo apt-get install python-mock=1.0.1
 

+.. hint:: To activate functional tests in kamaki. enable the preconfigured
+    *livetest* command group:
+
+    .. code-block:: console
+
+        $ kamaki config set livetest_cli livetest
+
+
+Install astakosclient (optional)
+""""""""""""""""""""""""""""""""
+
+A seperate project called
+`astakosclient <https://pypi.python.org/pypi/astakosclient>`_ can be used for
+advanced user and service management.
+
+.. code-block:: console
+
+    $ apt-get install python-astakosclient
+
+.. hint:: To activate astakosclient commands in kamaki, enable the
+    preconfigured *astakos* command group:
+
+    .. code-block:: console
+
+        $ kamaki config set astakos_cli astakos
+

 .. _installing-from-pypi-ref:
 
 Installing from pypi
 .. _installing-from-pypi-ref:
 
 Installing from pypi

@@ -109,7 +136,7 @@ Optional:
 Setup a virtual enviroment (optional)
 """""""""""""""""""""""""""""""""""""
 
 Setup a virtual enviroment (optional)
 """""""""""""""""""""""""""""""""""""
 

-With virtualenv users can setup kamaki and synnefo services in a sandbox
+With virtualenv users can setup kamaki and Synnefo services in a sandbox

 environment.
 
 .. code-block:: console
 environment.
 
 .. code-block:: console

@@ -127,8 +154,8 @@ Install kamaki
 
     $ pip install kamaki
 
 
     $ pip install kamaki
 

-Install ansicolors (optional)
-"""""""""""""""""""""""""""""
+Install ansicolors
+""""""""""""""""""

 
 The **ansicolors** package is not required for running kamaki, but it is
 recommended as a user experience improvement. In specific, ansicolors
 
 The **ansicolors** package is not required for running kamaki, but it is
 recommended as a user experience improvement. In specific, ansicolors

@@ -153,6 +180,31 @@ mock.
 
 .. warning:: mock version >= 1.X
 
 
 .. warning:: mock version >= 1.X
 

+.. hint:: To activate functional tests in kamaki. enable the preconfigured
+    *livetest* command group:
+
+    .. code-block:: console
+
+        $ kamaki config set livetest_cli livetest
+
+Install astakosclient
+"""""""""""""""""""""
+
+A seperate project called
+`astakosclient <https://pypi.python.org/pypi/astakosclient>`_ can be used for
+advanced user and service management.
+
+.. code-block:: console
+
+    $ pip install astakosclient
+
+.. hint:: To activate astakosclient commands in kamaki, enable the
+    preconfigured *astakos* command group:
+
+    .. code-block:: console
+
+        $ kamaki config set astakos_cli astakos
+

 Mac OS X
 --------
 
 Mac OS X
 --------
 

@@ -174,10 +226,10 @@ Requirements
 
 * Setuptools (`Official versions and workarounds <http://pypi.python.org/pypi/setuptools>`_)
 
 
 * Setuptools (`Official versions and workarounds <http://pypi.python.org/pypi/setuptools>`_)
 

-Users who have already set up and wokring python and setuptools (e.g. for
-another project) may skip python and / or setup tools installation.
+Users who have already set up and wokring python and setuptools (e.g., for
+another project) may skip Python and / or setuptools installation.

 
 

-Install python
+Install Python

 ^^^^^^^^^^^^^^
 
 Download and run the Windows installer from
 ^^^^^^^^^^^^^^
 
 Download and run the Windows installer from

@@ -186,10 +238,10 @@ Download and run the Windows installer from
 Users should pick the installer that fits their windows version and machine
 architecture.
 
 Users should pick the installer that fits their windows version and machine
 architecture.
 

-Add python to windows path
+Add Python to windows path

 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 

-The following will allow users to run python and python scripts from command
+The following will allow users to run Python and Python scripts from command

 line.
 
 * Select **System** from the Control Panel, select the **Advanced** tab, the
 line.
 
 * Select **System** from the Control Panel, select the **Advanced** tab, the