Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SamR1 committed Jul 17, 2021
1 parent 9254c02 commit c944478
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 19 deletions.
19 changes: 13 additions & 6 deletions docs/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ From sources
$ yay poetry
$ poetry --version
Poetry 1.0.10
Poetry 1.0.17
# optional
$ poetry config virtualenvs.in-project true
Expand Down Expand Up @@ -492,7 +492,7 @@ Dev environment
$ git pull
- Update **.env** if needed
- Update **.env** if needed (see `Environment variables <installation.html#environment-variables>`__).

- Upgrade packages and database:

Expand All @@ -516,19 +516,26 @@ Dev environment
Prod environment
""""""""""""""""

- Stop the application and pull the repository:
- Stop the application

- Change to the directory where FitTrackee directory is located

- Download the last release (for now, it is the release v0.4.9) and overwrite existing files:

.. code:: bash
$ git pull
$ wget https://github.com/SamR1/FitTrackee/archive/v0.4.9.tar.gz
$ tar -xzf v0.4.9.tar.gz
$ cp -R FitTrackee-0.4.9/* FitTrackee/
$ cd FitTrackee
- Update **.env** if needed
- Update **.env** if needed (see `Environment variables <installation.html#environment-variables>`__).

- Upgrade packages and database:

.. code:: bash
$ make install
$ make install-python
$ make upgrade-db
- Restart the server and dramatiq workers:
Expand Down
17 changes: 11 additions & 6 deletions docs/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -663,7 +663,7 @@ <h2>From sources<a class="headerlink" href="#from-sources" title="Permalink to t
</div>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ yay poetry
$ poetry --version
Poetry <span class="m">1</span>.0.10
Poetry <span class="m">1</span>.0.17

<span class="c1"># optional</span>
$ poetry config virtualenvs.in-project <span class="nb">true</span>
Expand Down Expand Up @@ -769,7 +769,7 @@ <h4>Dev environment<a class="headerlink" href="#id4" title="Permalink to this he
</pre></div>
</div>
<ul class="simple">
<li><p>Update <strong>.env</strong> if needed</p></li>
<li><p>Update <strong>.env</strong> if needed (see <a class="reference external" href="installation.html#environment-variables">Environment variables</a>).</p></li>
<li><p>Upgrade packages and database:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make install-dev
Expand All @@ -792,16 +792,21 @@ <h4>Dev environment<a class="headerlink" href="#id4" title="Permalink to this he
<section id="prod-environment">
<h4>Prod environment<a class="headerlink" href="#prod-environment" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><p>Stop the application and pull the repository:</p></li>
<li><p>Stop the application</p></li>
<li><p>Change to the directory where FitTrackee directory is located</p></li>
<li><p>Download the last release (for now, it is the release v0.4.9) and overwrite existing files:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git pull
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ wget https://github.com/SamR1/FitTrackee/archive/v0.4.9.tar.gz
$ tar -xzf v0.4.9.tar.gz
$ cp -R FitTrackee-0.4.9/* FitTrackee/
$ <span class="nb">cd</span> FitTrackee
</pre></div>
</div>
<ul class="simple">
<li><p>Update <strong>.env</strong> if needed</p></li>
<li><p>Update <strong>.env</strong> if needed (see <a class="reference external" href="installation.html#environment-variables">Environment variables</a>).</p></li>
<li><p>Upgrade packages and database:</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make install
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make install-python
$ make upgrade-db
</pre></div>
</div>
Expand Down
Loading

0 comments on commit c944478

Please sign in to comment.