summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorÉtienne Loks <etienne.loks@peacefrogs.net>2013-03-16 13:10:57 +0100
committerÉtienne Loks <etienne.loks@peacefrogs.net>2013-03-16 18:39:48 +0100
commit9ecb73a98f1468d46284f0bfbeefabd874f02efd (patch)
tree164575545ab9c41dbbee387d0e82758724820528
parentd02ec4246813eb0787bf3ab54af1af9ce32bd376 (diff)
downloadChimère-9ecb73a98f1468d46284f0bfbeefabd874f02efd.tar.bz2
Chimère-9ecb73a98f1468d46284f0bfbeefabd874f02efd.zip
Update documentation
-rw-r--r--docs/en/install.rst29
-rw-r--r--docs/en/upgrade.rst64
-rw-r--r--docs/fr/install.rst28
-rw-r--r--docs/fr/upgrade.rst65
4 files changed, 142 insertions, 44 deletions
diff --git a/docs/en/install.rst b/docs/en/install.rst
index 1bb5771..59884b7 100644
--- a/docs/en/install.rst
+++ b/docs/en/install.rst
@@ -5,15 +5,18 @@ Installation
============
:Author: Étienne Loks
-:date: 2013-02-01
+:date: 2013-03-16
:Copyright: CC-BY 3.0
This document presents the installation of Chimère.
-It has been updated for version 2.0.0.
Prerequisites
*************
+If you want to install the Chimère package for Debian Wheezy dependencies are
+managed by the package.
+You can go to the next section of the documentation.
+
- `Apache <http://www.apache.org/>`_ version 2.x
- `Python <http://www.python.org/>`_ versions 2.6 or 2.7
- `Django <http://www.djangoproject.com/>`_ >= version 1.4
@@ -103,6 +106,23 @@ Choose a path to install your Chimère::
INSTALL_PATH=/var/local/django
mkdir $INSTALL_PATH
+From Debian package
++++++++++++++++++++
+
+If you want to install the last stable version of Chimère
+and your system is under Debian Wheezy it is wise to use
+Chimère Debian packages.
+
+You can install Chimère this way.
+
+.. code-block:: bash
+
+ # add Chimère repository
+ echo "deb http://debian.peacefrogs.net wheezy main" >> /etc/apt/sources.list
+ apt-get update
+ # install
+ apt-get install python-django-chimere
+
From an archive
+++++++++++++++
@@ -131,11 +151,12 @@ From the Git repository
Another solution is to get it from the Git repository::
+ CHIMERE_LOCALNAME=mychimere
+ CHIMERE_BRANCH=v2.0 # choose v2.0 for stable ou master for bleeding edge
cd $INSTALL_PATH
git clone git://www.peacefrogs.net/git/chimere
cd chimere
- git tag -l # list tagged versions
- git checkout v2.0 # checkout the desired version
+ git checkout origin/$CHIMERE_BRANCH
Creating a custom project template
diff --git a/docs/en/upgrade.rst b/docs/en/upgrade.rst
index d0eaa4c..7ed2a3f 100644
--- a/docs/en/upgrade.rst
+++ b/docs/en/upgrade.rst
@@ -5,11 +5,10 @@ Upgrade
=======
:Author: Étienne Loks
-:date: 2013-02-01
+:date: 2013-03-16
:Copyright: CC-BY 3.0
This document presents the upgrade of Chimère.
-It has been updated for version 2.0.0.
.. Warning::
Before any upgrade backup the database and all your installation files
@@ -34,6 +33,10 @@ The instructions are given for Debian Squeeze and Debian Wheezy.
Getting new versions of dependencies
------------------------------------
+If you want to install the Chimère package for Debian Wheezy dependencies are
+managed by the package.
+You can go to the next section of the documentation.
+
Version 1.1 -> 1.2
******************
@@ -71,19 +74,15 @@ If you are planning to do major import consider the install of `Celery
Getting the new sources
-----------------------
-First of all you have to get the new version of the source code.
-For the upgrade process, the source code has to be from the Git
-repository.
-
To simplify further instructions, some environment variables are
initialized.
.. code-block:: bash
CHIMERE_PATH=/srv/chimere
- CHIMERE_TAG=v1.2.0 # version 1.1 -> 1.2
- CHIMERE_TAG=v2.0-RC3 # version 1.2 -> 2.0
- CHIMERE_TAG=master # version 2.0 -> master
+ CHIMERE_BRANCH=v1.2 # version 1.1 -> 1.2
+ CHIMERE_BRANCH=v2.0 # version 1.2 -> 2.0
+ CHIMERE_BRANCH=master # version 2.0 -> master
CHIMERE_LOCALNAME=mychimere
Your local name is used for the name of your local Git branch and the Python
@@ -92,21 +91,49 @@ it must be at least one letter and can have a string of numbers, letters and
underscores ("_") to any length. Don't begin the name by "_" because it has special
significance in Python.
+From Debian package
+*******************
+
+If you want to install the last stable version of Chimère
+and your system is under Debian Wheezy it is wise to use
+Chimère Debian packages.
+
+If you have a previous installation from sources remove
+all chimère libraries but **keep** your project dir.
+
+.. code-block:: bash
+
+ rm -rf $CHIMERE_PATH/chimere
+
+Then you can install Chimère.
+
+.. code-block:: bash
+
+ # add Chimère repository
+ echo "deb http://debian.peacefrogs.net wheezy main" >> /etc/apt/sources.list
+ apt-get update
+ # install
+ apt-get install python-django-chimere
+
+
+Installation from sources
+*************************
+
+First of all you have to get the new version of the source code.
+For the upgrade process, the source code has to be from the Git
+repository.
+
From a previous Git installation
-********************************
+++++++++++++++++++++++++++++++++
.. code-block:: bash
cd $CHIMERE_PATH
- git checkout -b $CHIMERE_LOCALNAME # only if you haven't created yet a local branch
git stash # if you have uncommited changes
- git checkout master
- git pull
- git checkout $CHIMERE_LOCALNAME
- git rebase $CHIMERE_TAG
+ git checkout origin/$CHIMERE_BRANCH -b $CHIMERE_LOCALNAME
From a previous tarball installation
-************************************
+++++++++++++++++++++++++++++++++++++
First remove your old installation and get the Git version:
@@ -117,8 +144,7 @@ First remove your old installation and get the Git version:
rm -rf $CHIMERE_PATH
git clone git://www.peacefrogs.net/git/chimere
cd chimere
- git checkout $CHIMERE_TAG
- git checkout -b $CHIMERE_LOCALNAME
+ git checkout origin/$CHIMERE_BRANCH -b $CHIMERE_LOCALNAME
Update basic settings
@@ -283,6 +309,8 @@ Version 2.0 -> master
cd $CHIMERE_APP_PATH
./manage.py syncdb
+ # les migrations ont été réinitialisées
+ ./manage.py migrate chimere --delete-ghost-migrations --fake 0001
./manage.py migrate chimere
Update translations
diff --git a/docs/fr/install.rst b/docs/fr/install.rst
index 8e8f8ce..2fbd804 100644
--- a/docs/fr/install.rst
+++ b/docs/fr/install.rst
@@ -5,14 +5,16 @@ Installation
============
:Auteur: Étienne Loks
-:date: 2013-02-01
+:date: 2013-03-16
:Copyright: CC-BY 3.0
Ce document présente l'installation de Chimère.
-Il a été mis à jour pour la version 2.0.0 de Chimère.
Pré-requis
**********
+Si vous souhaitez installer le paquet Debian prévu pour Wheezy, les dépendances
+sont gérées par le paquet.
+Vous pouvez passer à la section suivante de la documentation.
- `Apache <http://www.apache.org/>`_ version 2.x
- `Python <http://www.python.org/>`_ versions 2.6 ou 2.7
@@ -99,6 +101,23 @@ Choisissez un chemin où installer Chimère ::
INSTALL_PATH=/var/local/django
mkdir $INSTALL_PATH
+Depuis les paquets Debian
++++++++++++++++++++++++++
+
+Si vous souhaitez disposer de la dernière version stable
+de Debian et que vous êtes sous environnement Wheezy, il est
+conseillé d'utiliser les paquets prévus à cet effet.
+
+Vous pouvez installer Chimère ainsi.
+
+.. code-block:: bash
+
+ # ajouter le dépôt Chimère
+ echo "deb http://debian.peacefrogs.net wheezy main" >> /etc/apt/sources.list
+ # installation
+ apt-get update
+ apt-get install python-django-chimere
+
Depuis une archive
++++++++++++++++++
@@ -128,11 +147,12 @@ Depuis le dépôt Git
Une autre solution est d'obtenir les sources depuis le dépôt Git : ::
+ CHIMERE_LOCALNAME=mychimere
+ CHIMERE_BRANCH=v2.0 # choisissez v2.0 ou master
cd $INSTALL_PATH
git clone git://www.peacefrogs.net/git/chimere
cd chimere
- git tag -l # lister les versions
- git checkout v2.0 # choisir la version désirée
+ git checkout origin/$CHIMERE_BRANCH -b $CHIMERE_LOCALNAME
Créez un patron pour votre projet
diff --git a/docs/fr/upgrade.rst b/docs/fr/upgrade.rst
index 841485b..f8693bc 100644
--- a/docs/fr/upgrade.rst
+++ b/docs/fr/upgrade.rst
@@ -5,11 +5,10 @@ Mise à jour
===========
:Auteur: Étienne Loks
-:date: 2013-02-01
+:date: 2013-03-16
:Copyright: CC-BY 3.0
Ce document présente la mise à jour de Chimère.
-Il a été mis à jour pour la version 2.0.0 de Chimère.
.. Warning::
Avant toute mise à jour faites une sauvegarde de la base de données et de
@@ -37,6 +36,10 @@ Les instructions sont données pour Debian Squeeze et Debian Wheezy.
Obtenir des nouvelles versions des dépendances
----------------------------------------------
+Si vous souhaitez installer le paquet Debian prévu pour Wheezy, les dépendances
+sont gérées par le paquet.
+Vous pouvez passer à la section suivante de la documentation.
+
Version 1.1 -> 1.2
******************
@@ -74,18 +77,15 @@ de `Celery <http://celeryproject.org/>`_.
Obtenir les nouvelles sources
-----------------------------
-Tout d'abord vous avez besoin de la nouvelle version du code source.
-Pour la procédure d'installation, le code source doit être celui du dépôt Git.
-
Pour simplifier les instructions suivantes, quelques variables d'environnement
sont initialisées.
.. code-block:: bash
CHIMERE_PATH=/srv/chimere
- CHIMERE_TAG=v1.2.0 # version 1.1 -> 1.2
- CHIMERE_TAG=v2.0-RC3 # version 1.2 -> 2.0
- CHIMERE_TAG=master # version 2.0 -> master
+ CHIMERE_BRANCH=v1.2 # version 1.1 -> 1.2
+ CHIMERE_BRANCH=v2.0 # version 1.2 -> 2.0
+ CHIMERE_BRANCH=master # version 2.0 -> master
CHIMERE_LOCALNAME=mychimere
Le nom de votre projet (*CHIMERE_LOCALNAME*) est utilisé pour le nom de la
@@ -97,23 +97,51 @@ comporter autant de nombres et de lettres que souhaité, le caractère tiret bas
(« _ ») est accepté. N'utilisez pas de caractères accentués. Ne commencez pas
par « _ » car cela a une signification particulière en Python.
+Depuis les paquets Debian
+*************************
+
+Si vous souhaitez disposer de la dernière version stable
+de Debian et que vous êtes sous environnement Wheezy, il est
+conseillé d'utiliser les paquets prévus à cet effet.
+
+Si vous avez une installation précédente depuis les sources
+effacez les répertoires contenant la bibliothèque de base
+**conservez** bien les répertoires contenant votre projet.
+
+.. code-block:: bash
+
+ rm -rf $CHIMERE_PATH/chimere
+
+Ensuite vous pouvez installer Chimère.
+
+.. code-block:: bash
+
+ # ajouter le dépôt Chimère
+ echo "deb http://debian.peacefrogs.net wheezy main" >> /etc/apt/sources.list
+ # installation
+ apt-get update
+ apt-get install python-django-chimere
+
+
+Installation depuis les sources
+*******************************
+
+Tout d'abord vous avez besoin de la nouvelle version du code source.
+Pour la procédure d'installation, le code source doit être celui du dépôt Git.
+
+
Pour une précédente installation Git
-************************************
+++++++++++++++++++++++++++++++++++++
.. code-block:: bash
cd $CHIMERE_PATH
- git checkout -b $CHIMERE_LOCALNAME # seulement si vous n'avez pas encore
- # créé votre branche locale
git stash # si vous avez des changements pas encore « commités »
- git checkout master
- git pull
- git checkout $CHIMERE_LOCALNAME
- git rebase $CHIMERE_TAG
+ git checkout origin/$CHIMERE_BRANCH -b $CHIMERE_LOCALNAME
Pour une précédente installation depuis une archive
-***************************************************
++++++++++++++++++++++++++++++++++++++++++++++++++++
Supprimez d'abord votre ancienne installation et obtenez la version Git :
@@ -124,8 +152,7 @@ Supprimez d'abord votre ancienne installation et obtenez la version Git :
rm -rf $CHIMERE_PATH
git clone git://www.peacefrogs.net/git/chimere
cd chimere
- git checkout $CHIMERE_TAG
- git checkout -b $CHIMERE_LOCALNAME
+ git checkout origin/$CHIMERE_BRANCH -b $CHIMERE_LOCALNAME
Mettre à jour les paramètres de base
@@ -301,6 +328,8 @@ Version 2.0 -> master
cd $CHIMERE_APP_PATH
./manage.py syncdb
+ # migrations have been reinitialized
+ ./manage.py migrate chimere --delete-ghost-migrations --fake 0001
./manage.py migrate chimere
Mise à jour des traductions