diff options
Diffstat (limited to 'docs/_build/html/upgrade.html')
| -rw-r--r-- | docs/_build/html/upgrade.html | 58 |
1 files changed, 32 insertions, 26 deletions
diff --git a/docs/_build/html/upgrade.html b/docs/_build/html/upgrade.html index c38cc8f..56d800c 100644 --- a/docs/_build/html/upgrade.html +++ b/docs/_build/html/upgrade.html @@ -64,17 +64,23 @@ </table> <p>This document presents the upgrade of Chimère. It has been updated for version 2.0.0.</p> -<p>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.</p> -<p>If several versions has been published, you should repeat any upgrading steps. +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p class="last">Before any upgrade backup the database and all your installation files +(specially if you have made changes to them).</p> +</div> +<p>The process for migration requires a basic knowledge of Git and Linux CLI. It is +<em>not</em> an easy process. A work is currently done to easy the upgrade in later +versions (>2.0) of Chimère.</p> +<p>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.</p> -<p>The current stable version is 2.0. -If you are considering to contribute on Chimère get the Git master.</p> -<p>The instruction are given for Debian Squeeze and Debian Wheezy.</p> +<p>The current stable version is 2.0.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">If you are considering to contribute on Chimère get the Git master.</p> +</div> +<p>The instructions are given for Debian Squeeze and Debian Wheezy.</p> <div class="section" id="getting-new-versions-of-dependencies"> <h2>Getting new versions of dependencies<a class="headerlink" href="#getting-new-versions-of-dependencies" title="Permalink to this headline">¶</a></h2> <div class="section" id="version-1-1-1-2"> @@ -100,7 +106,7 @@ Then install the new dependencies:</p> python-pyexiv2 python-feedparser javascript-common </pre></div> </div> -<p>If you are planing to do major import consider the install of <a class="reference external" href="http://celeryproject.org/">Celery</a>.</p> +<p>If you are planning to do major import consider the install of <a class="reference external" href="http://celeryproject.org/">Celery</a>.</p> <div class="highlight-bash"><div class="highlight"><pre>apt-get install python-django-celery python-kombu </pre></div> </div> @@ -109,8 +115,8 @@ Then install the new dependencies:</p> </div> <div class="section" id="getting-the-new-sources"> <h2>Getting the new sources<a class="headerlink" href="#getting-the-new-sources" title="Permalink to this headline">¶</a></h2> -<p>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 +<p>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.</p> <p>To simplify further instructions, some environment variables are initialized.</p> @@ -121,15 +127,15 @@ initialized.</p> <span class="nv">CHIMERE_LOCALNAME</span><span class="o">=</span>mychimere </pre></div> </div> -<p>Your local name is used for the name of your local git branch and the Python +<p>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.</p> <div class="section" id="from-a-previous-git-installation"> <h3>From a previous Git installation<a class="headerlink" href="#from-a-previous-git-installation" title="Permalink to this headline">¶</a></h3> <div class="highlight-bash"><div class="highlight"><pre><span class="nb">cd</span> <span class="nv">$CHIMERE_PATH</span> -git checkout -b <span class="nv">$CHIMERE_LOCALNAME</span> <span class="c"># do it only if you haven't yet create a local branch</span> +git checkout -b <span class="nv">$CHIMERE_LOCALNAME</span> <span class="c"># only if you haven't created yet a local branch</span> git stash <span class="c"># if you have uncommited changes</span> git checkout master git pull @@ -140,7 +146,7 @@ git rebase <span class="nv">$CHIMERE_TAG</span> </div> <div class="section" id="from-a-previous-tarball-installation"> <h3>From a previous tarball installation<a class="headerlink" href="#from-a-previous-tarball-installation" title="Permalink to this headline">¶</a></h3> -<p>First remove your old installation and get the Git version.</p> +<p>First remove your old installation and get the Git version:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nb">cd</span> <span class="nv">$CHIMERE_PATH</span> <span class="nb">cd</span> .. rm -rf <span class="nv">$CHIMERE_PATH</span> @@ -159,7 +165,7 @@ git checkout -b <span class="nv">$CHIMERE_LOCALNAME</span> vim <span class="nv">$CHIMERE_APP_PATH</span>/settings.py </pre></div> </div> -<p>Add the line (adapted for your jquery and gpsbabel installation).</p> +<p>Add the line (adapted for your jquery and gpsbabel installation):</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">JQUERY_URL</span> <span class="o">=</span> <span class="n">SERVER_URL</span> <span class="o">+</span> <span class="s">'jquery/jquery-1.4.4.min.js'</span> <span class="n">GPSBABEL</span> <span class="o">=</span> <span class="s">'/usr/bin/gpsbabel'</span> <span class="c"># simplify with an error of 5 meters</span> @@ -171,7 +177,7 @@ vim <span class="nv">$CHIMERE_APP_PATH</span>/settings.py <h4>Version 1.2 -> 2.0<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h4> <div class="section" id="project-template"> <h5>Project template<a class="headerlink" href="#project-template" title="Permalink to this headline">¶</a></h5> -<p>Create a new project template.</p> +<p>Create a new project template:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nb">cd</span> <span class="nv">$CHIMERE_PATH</span> cp -ra <span class="nv">$CHIMERE_PATH</span>/example_project <span class="nv">$CHIMERE_LOCALNAME</span> <span class="nv">CHIMERE_APP_PATH</span><span class="o">=</span><span class="nv">$CHIMERE_PATH</span>/<span class="nv">$CHIMERE_LOCALNAME</span> @@ -201,12 +207,12 @@ chown www-data -R /var/log/django </div> <div class="section" id="static-files"> <h5>Static files<a class="headerlink" href="#static-files" title="Permalink to this headline">¶</a></h5> -<p>Now static file are managed with <em>django.contrib.staticfiles</em>.</p> +<p>Now static files are managed with <em>django.contrib.staticfiles</em>.</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nb">cd</span> <span class="nv">$CHIMERE_APP_PATH</span> ./manage.py collectstatic </pre></div> </div> -<p>Move old static files to the new static directory.</p> +<p>Move old static files to the new static directory:</p> <div class="highlight-bash"><div class="highlight"><pre>cp -ra <span class="nv">$CHIMERE_PATH</span>/chimere/static/* <span class="nv">$CHIMERE_APP_PATH</span>/static/ cp -ra <span class="nv">$CHIMERE_PATH</span>/chimere/static/icons/* <span class="nv">$CHIMERE_APP_PATH</span>/media/icons/ cp -ra <span class="nv">$CHIMERE_PATH</span>/chimere/static/upload <span class="nv">$CHIMERE_APP_PATH</span>/media/ @@ -268,7 +274,7 @@ python ./scripts/upgrade.py values of an old <em>Property model</em> to this new field, a script is available.</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nb">cd</span> <span class="nv">$CHIMERE_APP_PATH</span> ../chimere/scripts/migrate_properties.py -<span class="c"># folow the instructions</span> +<span class="c"># follow the instructions</span> </pre></div> </div> </div> @@ -298,9 +304,9 @@ django-admin compilemessages </div> </div> </div> -<div class="section" id="forcing-the-upgrade-of-visitor-s-web-browser-cache"> -<h2>Forcing the upgrade of visitor’s web browser cache<a class="headerlink" href="#forcing-the-upgrade-of-visitor-s-web-browser-cache" title="Permalink to this headline">¶</a></h2> -<p>If major changes in the javascript has be done between version, many of your +<div class="section" id="forcing-the-refresh-of-visitor-s-web-browser-cache"> +<h2>Forcing the refresh of visitor’s web browser cache<a class="headerlink" href="#forcing-the-refresh-of-visitor-s-web-browser-cache" title="Permalink to this headline">¶</a></h2> +<p>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:</p> @@ -311,7 +317,7 @@ that edit your local_settings.py and change:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">STATIC_URL</span> <span class="o">=</span> <span class="s">'/static/v2.0.0/'</span> </pre></div> </div> -<p>Then in the static directory.</p> +<p>Then in the static directory:</p> <div class="highlight-bash"><div class="highlight"><pre><span class="nb">cd</span> <span class="nv">$CHIMERE_APP_PATH</span>/static ln -s <span class="sb">`</span><span class="nb">pwd</span><span class="sb">`</span> v2.0.0 </pre></div> @@ -367,7 +373,7 @@ ln -s <span class="sb">`</span><span class="nb">pwd</span><span class="sb">`</sp <li><a class="reference internal" href="#version-1-2-2-0-master">Version 1.2 -> 2.0 -> master</a></li> </ul> </li> -<li><a class="reference internal" href="#forcing-the-upgrade-of-visitor-s-web-browser-cache">Forcing the upgrade of visitor’s web browser cache</a></li> +<li><a class="reference internal" href="#forcing-the-refresh-of-visitor-s-web-browser-cache">Forcing the refresh of visitor’s web browser cache</a></li> </ul> </li> </ul> |