update docs

docs/_sources/installation.rst.txt

@@ -13,7 +13,7 @@ This application is written in Python (API) and Javascript (client):
     - `Leaflet <https://leafletjs.com/>`__ to display map
     - `Recharts <https://github.com/recharts/recharts>`__ to display charts with elevation and speed
 
-Sports and weather icons are made by Freepik from www.flaticon.com.
+Sports and weather icons are made by `Freepik <https://www.freepik.com/>`__ from `www.flaticon.com <https://www.flaticon.com/>`__.
 
 Prerequisites
 ~~~~~~~~~~~~~
@@ -108,5 +108,38 @@ password
 Upgrade
 ~~~~~~~
 
+.. warning::
+    | Before upgrading, make a backup of all data:
+    | - database (with `pg_dump <https://www.postgresql.org/docs/11/app-pgdump.html>`__ for instance)
+    | - upload directory: **FitTrackee/fittrackee_api/fittrackee_api/uploads/**
+
+
+Dev environment
+^^^^^^^^^^^^^^^
+
+- Stop the application and pull the repository:
+
+.. code:: bash
+
+   $ git pull
+
+- Update **Makefile.config** and **Makefile.custom.config** file if needed
+
+- Reinstall packages if needed:
+
+.. code:: bash
+
+   $ make install-dev
+
+- Restart the server and the client:
+
+.. code:: bash
+
+   $ make serve
+
+
+Prod environment
+^^^^^^^^^^^^^^^^
+
 ``TODO``
 

docs/installation.html

@@ -80,7 +80,11 @@
 <li><a class="reference internal" href="#prod-environment">Prod environment</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#upgrade">Upgrade</a></li>
+<li><a class="reference internal" href="#upgrade">Upgrade</a><ul>
+<li><a class="reference internal" href="#id2">Dev environment</a></li>
+<li><a class="reference internal" href="#id3">Prod environment</a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
@@ -154,7 +158,7 @@
 </dl>
 </li>
 </ul>
-<p>Sports and weather icons are made by Freepik from www.flaticon.com.</p>
+<p>Sports and weather icons are made by <a class="reference external" href="https://www.freepik.com/">Freepik</a> from <a class="reference external" href="https://www.flaticon.com/">www.flaticon.com</a>.</p>
 <div class="section" id="prerequisites">
 <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
@@ -244,8 +248,41 @@ password</p>
 </div>
 <div class="section" id="upgrade">
 <h2>Upgrade<a class="headerlink" href="#upgrade" title="Permalink to this headline">¶</a></h2>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<div class="line-block">
+<div class="line">Before upgrading, make a backup of all data:</div>
+<div class="line">- database (with <a class="reference external" href="https://www.postgresql.org/docs/11/app-pgdump.html">pg_dump</a> for instance)</div>
+<div class="line">- upload directory: <strong>FitTrackee/fittrackee_api/fittrackee_api/uploads/</strong></div>
+</div>
+</div>
+<div class="section" id="id2">
+<h3>Dev environment<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
+<ul class="simple">
+<li><p>Stop the application and pull the repository:</p></li>
+</ul>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git pull
+</pre></div>
+</div>
+<ul class="simple">
+<li><p>Update <strong>Makefile.config</strong> and <strong>Makefile.custom.config</strong> file if needed</p></li>
+<li><p>Reinstall packages if needed:</p></li>
+</ul>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make install-dev
+</pre></div>
+</div>
+<ul class="simple">
+<li><p>Restart the server and the client:</p></li>
+</ul>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make serve
+</pre></div>
+</div>
+</div>
+<div class="section" id="id3">
+<h3>Prod environment<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
 <p><code class="docutils literal notranslate"><span class="pre">TODO</span></code></p>
 </div>
+</div>
 </div>
 
 

docsrc/source/installation.rst

@@ -13,7 +13,7 @@ This application is written in Python (API) and Javascript (client):
     - `Leaflet <https://leafletjs.com/>`__ to display map
     - `Recharts <https://github.com/recharts/recharts>`__ to display charts with elevation and speed
 
-Sports and weather icons are made by Freepik from www.flaticon.com.
+Sports and weather icons are made by `Freepik <https://www.freepik.com/>`__ from `www.flaticon.com <https://www.flaticon.com/>`__.
 
 Prerequisites
 ~~~~~~~~~~~~~
@@ -108,5 +108,38 @@ password
 Upgrade
 ~~~~~~~
 
+.. warning::
+    | Before upgrading, make a backup of all data:
+    | - database (with `pg_dump <https://www.postgresql.org/docs/11/app-pgdump.html>`__ for instance)
+    | - upload directory: **FitTrackee/fittrackee_api/fittrackee_api/uploads/**
+
+
+Dev environment
+^^^^^^^^^^^^^^^
+
+- Stop the application and pull the repository:
+
+.. code:: bash
+
+   $ git pull
+
+- Update **Makefile.config** and **Makefile.custom.config** file if needed
+
+- Reinstall packages if needed:
+
+.. code:: bash
+
+   $ make install-dev
+
+- Restart the server and the client:
+
+.. code:: bash
+
+   $ make serve
+
+
+Prod environment
+^^^^^^^^^^^^^^^^
+
 ``TODO``