diff options
Diffstat (limited to 'docs/upgrade.rst')
| -rw-r--r-- | docs/upgrade.rst | 48 |
1 files changed, 26 insertions, 22 deletions
diff --git a/docs/upgrade.rst b/docs/upgrade.rst index 796ed98..377e5e7 100644 --- a/docs/upgrade.rst +++ b/docs/upgrade.rst @@ -11,20 +11,24 @@ Upgrade This document presents the upgrade of Chimère. It has been updated for version 2.0.0. -Before any upgrade backup the database and all your installation files -(specially if you have made changes to them). +.. Warning:: + Before any upgrade backup the database and all your installation files + (specially if you have made changes to them). + The process for migration requires a basic knowledge of Git and Linux CLI. It is -not an easy process. A work is done to easy the upgrade in later versions (>2.0) -of Chimère. +*not* an easy process. A work is currently done to easy the upgrade in later +versions (>2.0) of Chimère. -If several versions has been published, you should repeat any upgrading steps. +If several versions have been published, you should repeat all upgrading steps. For instance to upgrade from v1.1 to v2.0 you should first upgrade to v1.2 then to v2.0. The only optional step is the integration of your customisations. The current stable version is 2.0. -If you are considering to contribute on Chimère get the Git master. -The instruction are given for Debian Squeeze and Debian Wheezy. +.. Note:: + If you are considering to contribute on Chimère get the Git master. + +The instructions are given for Debian Squeeze and Debian Wheezy. Getting new versions of dependencies @@ -57,7 +61,7 @@ Debian Wheezy apt-get install python-django-south python-simplejson libjs-jquery-ui \ python-pyexiv2 python-feedparser javascript-common -If you are planing to do major import consider the install of `Celery +If you are planning to do major import consider the install of `Celery <http://celeryproject.org/>`_. .. code-block:: bash @@ -67,8 +71,8 @@ If you are planing to do major import consider the install of `Celery Getting the new sources ----------------------- -First of all we have to get the new version of the source code. -For this upgrade process, we are getting the source code from the Git +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 @@ -82,10 +86,10 @@ initialized. CHIMERE_TAG=master # version 2.0 -> master CHIMERE_LOCALNAME=mychimere -Your local name is used for the name of your local git branch and the Python +Your local name is used for the name of your local Git branch and the Python package. As a Python package it should follow the rule of Python variable name: it must be at least one letter and can have a string of numbers, letters and -"_" to any length. Don't begin the name by "_" because it has special +underscores ("_") to any length. Don't begin the name by "_" because it has special significance in Python. From a previous Git installation @@ -94,7 +98,7 @@ From a previous Git installation .. code-block:: bash cd $CHIMERE_PATH - git checkout -b $CHIMERE_LOCALNAME # do it only if you haven't yet create a local branch + 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 @@ -104,7 +108,7 @@ From a previous Git installation From a previous tarball installation ************************************ -First remove your old installation and get the Git version. +First remove your old installation and get the Git version: .. code-block:: bash @@ -128,7 +132,7 @@ Version 1.1 -> 1.2 CHIMERE_APP_PATH=$CHIMERE_PATH/chimere vim $CHIMERE_APP_PATH/settings.py -Add the line (adapted for your jquery and gpsbabel installation). +Add the line (adapted for your jquery and gpsbabel installation): .. code-block:: python @@ -142,7 +146,7 @@ Version 1.2 -> 2.0 Project template ................ -Create a new project template. +Create a new project template: .. code-block:: bash @@ -177,14 +181,14 @@ Logging is now enabled by default in the file */var/log/django/chimere.log*. Static files ............ -Now static file are managed with *django.contrib.staticfiles*. +Now static files are managed with *django.contrib.staticfiles*. .. code-block:: bash cd $CHIMERE_APP_PATH ./manage.py collectstatic -Move old static files to the new static directory. +Move old static files to the new static directory: .. code-block:: bash @@ -260,7 +264,7 @@ values of an old *Property model* to this new field, a script is available. cd $CHIMERE_APP_PATH ../chimere/scripts/migrate_properties.py - # folow the instructions + # follow the instructions From 2.0 to master ****************** @@ -290,10 +294,10 @@ Version 1.2 -> 2.0 -> master cd $CHIMERE_PATH/chimere django-admin compilemessages -Forcing the upgrade of visitor's web browser cache +Forcing the refresh of visitor's web browser cache -------------------------------------------------- -If major changes in the javascript has be done between version, many of your +If major changes in the javascript has been done between versions, many of your users could experience problems. There are many tricks to force the refresh of their cache. One of them is to change the location of statics files. To do that edit your local_settings.py and change:: @@ -304,7 +308,7 @@ to:: STATIC_URL = '/static/v2.0.0/' -Then in the static directory. +Then in the static directory: .. code-block:: bash |