From: Nikos Skalkotos <skalkoto@grnet.gr>
Date: Thu, 27 Jun 2013 13:18:07 +0000 (+0300)
Subject: Update the documentation
X-Git-Tag: 0.5~1^2~22
X-Git-Url: https://code.grnet.gr/git/snf-image-creator/commitdiff_plain/d7a0de810cdae91f6d4e6650bf5d00f50ad3bf4e

Update the documentation

 * Add instruction on how to install the debian packages
 * Update version to 0.4.1
 * Add a small comment about the diskdump format
---

diff --git a/docs/conf.py b/docs/conf.py
index 28b2d66..4d729c8 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -50,9 +50,9 @@ copyright = u'2012, 2013 GRNET S.A. All rights reserved'
 # built documents.
 #
 # The short X.Y version.
-version = '0.4'
+version = '0.4.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.4'
+release = '0.4.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/docs/install.rst b/docs/install.rst
index dfd0dd4..59665c4 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -32,11 +32,41 @@ method you choose. There are two installation methods available:
 Install snf-image-creator using packages
 ========================================
 
+Debian
+------
+
+For *Debian 7.0 (wheezy)* you can use our official packages found in our
+development repository.
+
+Add the following line to */etc/apt/sources.list*:
+
+.. code-block:: console
+
+   deb http://apt.dev.grnet.gr wheezy/
+
+And resynchronize the package index files from their sources:
+
+.. code-block:: console
+
+   $ sudo apt-get update
+
+You should be able to list the package by calling:
+
+.. code-block:: console
+
+   $ apt-cache showpkg snf-image-creator
+
+And install the package with this command:
+
+.. code-block:: console
+
+   $ apt-get install snf-image-creator
+
 Ubuntu
 ------
 
-For *Ubuntu 12.04 LTS* and *12.10* systems, you can use our official packages
-found in *grnet/synnefo* Lauchpad PPA.
+For *Ubuntu 12.04 LTS*, *12.10* and *13.04* systems, you can use our official
+packages found in *grnet/synnefo* Lauchpad PPA.
 
 Add the synnefo PPA in your system:
 
@@ -47,7 +77,7 @@ Add the synnefo PPA in your system:
 
 If *apt-add-repository* is missing, first install:
 
-*software-properties-common* (Ubuntu 12.10):
+*software-properties-common* (Ubuntu 12.10 & 13.04):
 
 .. code-block:: console
 
@@ -76,14 +106,6 @@ Install the package by issuing:
    If you are asked during the installation to create/update a
    "supermin appliance", choose "Yes".
 
-.. warning::
-   In *Ubuntu 12.10* the current package of libguestfs (1.18-2) is broken. Take
-   a look at the open `bug report <https://bugs.launchpad.net/ubuntu/quantal/+source/libguestfs/+bug/1086974>`_.
-   Until version 1.18-2ubunut1 is out, you may workaround this problem by
-   creating a symlink like this:
-
-   *sudo ln -s /usr/lib/guestfs /usr/lib/x86_64-linux-gnu/guestfs*
-
 Fedora
 ------
 
diff --git a/docs/overview.rst b/docs/overview.rst
index 2cd3a19..0d57e0e 100644
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -35,6 +35,7 @@ deployment as private or public image.
 Image Format
 ============
 
-The extracted images are in diskdump format. This is the recommended format for
+The extracted images are in diskdump format, which is a raw dump of a disk
+device (or file). This is the recommended format for
 `snf-image <https://code.grnet.gr/projects/snf-image>`_, the Ganeti OS
 Definition used by `Synnefo <https://code.grnet.gr/projects/synnefo>`_.