Alexander/FitTrackee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
Sam 2021-07-10 10:46:44 +02:00
parent 90765d733b
commit fc86ddbbed
8 changed files with 52 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/_sources/installation.rst.txt
View File

@ -26,7 +26,7 @@ Prerequisites
- API key from `Dark Sky <https://darksky.net/dev>`__ [not mandatory] - API key from `Dark Sky <https://darksky.net/dev>`__ [not mandatory]
- SMTP provider - SMTP provider
- `Yarn <https://yarnpkg.com>`__ (for development only) - `Yarn <https://yarnpkg.com>`__ (for development only)
- Docker (for development only, to start `MailHog <https://github.com/mailhog/MailHog>`__ or evaluation purposes) - Docker (for development only, to start `MailHog <https://github.com/mailhog/MailHog>`__ or for evaluation purposes)
.. note:: .. note::
| The following steps describe an installation on Linux systems (tested | The following steps describe an installation on Linux systems (tested
@ -396,7 +396,7 @@ Dev environment
$ git clone https://github.com/SamR1/FitTrackee.git $ git clone https://github.com/SamR1/FitTrackee.git
$ cd FitTrackee $ cd FitTrackee
- Create **Makefile.custom.config** from example and update it - Create **.env** from example and update it
(see `Environment variables <installation.html#environment-variables>`__). (see `Environment variables <installation.html#environment-variables>`__).
- Install Python virtualenv, React and all related packages and - Install Python virtualenv, React and all related packages and
@ -429,16 +429,16 @@ Production environment
.. warning:: .. warning::
| Note that FitTrackee is under heavy development, some features may be unstable. | Note that FitTrackee is under heavy development, some features may be unstable.
- Download the last release (for now, it is the release v0.4.0): - Download the last release (for now, it is the release v0.4.8):
.. code:: bash .. code:: bash
$ wget https://github.com/SamR1/FitTrackee/archive/v0.4.0.tar.gz $ wget https://github.com/SamR1/FitTrackee/archive/v0.4.8.tar.gz
$ tar -xzf v0.4.0.tar.gz $ tar -xzf v0.4.8.tar.gz
$ mv FitTrackee-0.4.0 FitTrackee $ mv FitTrackee-0.4.8 FitTrackee
$ cd FitTrackee $ cd FitTrackee
- Create **Makefile.custom.config** from example and update it - Create **.env** from example and update it
(see `Environment variables <installation.html#environment-variables>`__). (see `Environment variables <installation.html#environment-variables>`__).
- Install Python virtualenv and all related packages: - Install Python virtualenv and all related packages:
@ -512,7 +512,7 @@ Prod environment
$ git pull $ git pull
- Update **Makefile.custom.config** if needed - Update **.env** if needed
- Upgrade packages and database: - Upgrade packages and database:

12
docs/_sources/troubleshooting/administrator.rst.txt
View File

@ -2,9 +2,13 @@ Administrator
############# #############
`JSON.parse: unexpected character at line 1 column 1 of the JSON data` `FitTrackee fails to start`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
On the **Network Tab**, if the requests are made to `http://localhost:3000/undefined/api`, that means the environnement variable **REACT_APP_API_URL** is not initialized. - Check the database URL in `Environment variables <../installation.html#envvar-DATABASE_URL>`__ if the following error is displayed in **gunicorn** logs:
Check if **Makefile.custom.config** file exists and **REACT_APP_API_URL** is correctly initialized (see `example <https://github.com/SamR1/FitTrackee/blob/master/Makefile.custom.config.example>`__), and rebuild the client. .. code::
sqlalchemy.exc.NoSuchModuleError: Can't load plugin: sqlalchemy.dialects:postgres
It must start with `postgresql://` (engine URLs starting with `postgres://` are no longer supported).

16
docs/installation.html
View File

@ -190,7 +190,7 @@
<li><p>API key from <a class="reference external" href="https://darksky.net/dev">Dark Sky</a> [not mandatory]</p></li> <li><p>API key from <a class="reference external" href="https://darksky.net/dev">Dark Sky</a> [not mandatory]</p></li>
<li><p>SMTP provider</p></li> <li><p>SMTP provider</p></li>
<li><p><a class="reference external" href="https://yarnpkg.com">Yarn</a> (for development only)</p></li> <li><p><a class="reference external" href="https://yarnpkg.com">Yarn</a> (for development only)</p></li>
<li><p>Docker (for development only, to start <a class="reference external" href="https://github.com/mailhog/MailHog">MailHog</a> or evaluation purposes)</p></li> <li><p>Docker (for development only, to start <a class="reference external" href="https://github.com/mailhog/MailHog">MailHog</a> or for evaluation purposes)</p></li>
</ul> </ul>
<div class="admonition note"> <div class="admonition note">
<p class="admonition-title">Note</p> <p class="admonition-title">Note</p>
@ -666,7 +666,7 @@ $ <span class="nb">cd</span> FitTrackee
</pre></div> </pre></div>
</div> </div>
<ul class="simple"> <ul class="simple">
<li><p>Create <strong>Makefile.custom.config</strong> from example and update it <li><p>Create <strong>.env</strong> from example and update it
(see <a class="reference external" href="installation.html#environment-variables">Environment variables</a>).</p></li> (see <a class="reference external" href="installation.html#environment-variables">Environment variables</a>).</p></li>
<li><p>Install Python virtualenv, React and all related packages and <li><p>Install Python virtualenv, React and all related packages and
initialize the database:</p></li> initialize the database:</p></li>
@ -699,16 +699,16 @@ and the password <code class="docutils literal notranslate"><span class="pre">mp
</div> </div>
</div> </div>
<ul class="simple"> <ul class="simple">
<li><p>Download the last release (for now, it is the release v0.4.0):</p></li> <li><p>Download the last release (for now, it is the release v0.4.8):</p></li>
</ul> </ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ wget https://github.com/SamR1/FitTrackee/archive/v0.4.0.tar.gz <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ wget https://github.com/SamR1/FitTrackee/archive/v0.4.8.tar.gz
$ tar -xzf v0.4.0.tar.gz $ tar -xzf v0.4.8.tar.gz
$ mv FitTrackee-0.4.0 FitTrackee $ mv FitTrackee-0.4.8 FitTrackee
$ <span class="nb">cd</span> FitTrackee $ <span class="nb">cd</span> FitTrackee
</pre></div> </pre></div>
</div> </div>
<ul class="simple"> <ul class="simple">
<li><p>Create <strong>Makefile.custom.config</strong> from example and update it <li><p>Create <strong>.env</strong> from example and update it
(see <a class="reference external" href="installation.html#environment-variables">Environment variables</a>).</p></li> (see <a class="reference external" href="installation.html#environment-variables">Environment variables</a>).</p></li>
<li><p>Install Python virtualenv and all related packages:</p></li> <li><p>Install Python virtualenv and all related packages:</p></li>
</ul> </ul>
@ -781,7 +781,7 @@ $ make upgrade-db
</pre></div> </pre></div>
</div> </div>
<ul class="simple"> <ul class="simple">
<li><p>Update <strong>Makefile.custom.config</strong> if needed</p></li> <li><p>Update <strong>.env</strong> if needed</p></li>
<li><p>Upgrade packages and database:</p></li> <li><p>Upgrade packages and database:</p></li>
</ul> </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

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

15
docs/troubleshooting/administrator.html
View File

@ -78,7 +78,7 @@
role="menu" role="menu"
aria-labelledby="dLabelLocalToc"><ul> aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">Administrator</a><ul> <li><a class="reference internal" href="#">Administrator</a><ul>
<li><a class="reference internal" href="#json-parse-unexpected-character-at-line-1-column-1-of-the-json-data"><cite>JSON.parse: unexpected character at line 1 column 1 of the JSON data</cite></a></li> <li><a class="reference internal" href="#fittrackee-fails-to-start"><cite>FitTrackee fails to start</cite></a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -130,10 +130,15 @@
<section id="administrator"> <section id="administrator">
<h1>Administrator<a class="headerlink" href="#administrator" title="Permalink to this headline"></a></h1> <h1>Administrator<a class="headerlink" href="#administrator" title="Permalink to this headline"></a></h1>
<section id="json-parse-unexpected-character-at-line-1-column-1-of-the-json-data"> <section id="fittrackee-fails-to-start">
<h2><cite>JSON.parse: unexpected character at line 1 column 1 of the JSON data</cite><a class="headerlink" href="#json-parse-unexpected-character-at-line-1-column-1-of-the-json-data" title="Permalink to this headline"></a></h2> <h2><cite>FitTrackee fails to start</cite><a class="headerlink" href="#fittrackee-fails-to-start" title="Permalink to this headline"></a></h2>
<p>On the <strong>Network Tab</strong>, if the requests are made to <cite>http://localhost:3000/undefined/api</cite>, that means the environnement variable <strong>REACT_APP_API_URL</strong> is not initialized.</p> <ul class="simple">
<p>Check if <strong>Makefile.custom.config</strong> file exists and <strong>REACT_APP_API_URL</strong> is correctly initialized (see <a class="reference external" href="https://github.com/SamR1/FitTrackee/blob/master/Makefile.custom.config.example">example</a>), and rebuild the client.</p> <li><p>Check the database URL in <a class="reference external" href="../installation.html#envvar-DATABASE_URL">Environment variables</a> if the following error is displayed in <strong>gunicorn</strong> logs:</p></li>
</ul>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sqlalchemy</span><span class="o">.</span><span class="n">exc</span><span class="o">.</span><span class="n">NoSuchModuleError</span><span class="p">:</span> <span class="n">Can</span><span class="s1">&#39;t load plugin: sqlalchemy.dialects:postgres</span>
</pre></div>
</div>
<p>It must start with <cite>postgresql://</cite> (engine URLs starting with <cite>postgres://</cite> are no longer supported).</p>
</section> </section>
</section> </section>

2
docs/troubleshooting/index.html
View File

@ -131,7 +131,7 @@
<p><span class="caption-text">Endpoints:</span></p> <p><span class="caption-text">Endpoints:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="administrator.html">Administrator</a><ul> <li class="toctree-l1"><a class="reference internal" href="administrator.html">Administrator</a><ul>
<li class="toctree-l2"><a class="reference internal" href="administrator.html#json-parse-unexpected-character-at-line-1-column-1-of-the-json-data"><cite>JSON.parse: unexpected character at line 1 column 1 of the JSON data</cite></a></li> <li class="toctree-l2"><a class="reference internal" href="administrator.html#fittrackee-fails-to-start"><cite>FitTrackee fails to start</cite></a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="user.html">User</a></li> <li class="toctree-l1"><a class="reference internal" href="user.html">User</a></li>

16
docsrc/source/installation.rst
View File

@ -26,7 +26,7 @@ Prerequisites
- API key from `Dark Sky <https://darksky.net/dev>`__ [not mandatory] - API key from `Dark Sky <https://darksky.net/dev>`__ [not mandatory]
- SMTP provider - SMTP provider
- `Yarn <https://yarnpkg.com>`__ (for development only) - `Yarn <https://yarnpkg.com>`__ (for development only)
- Docker (for development only, to start `MailHog <https://github.com/mailhog/MailHog>`__ or evaluation purposes) - Docker (for development only, to start `MailHog <https://github.com/mailhog/MailHog>`__ or for evaluation purposes)
.. note:: .. note::
| The following steps describe an installation on Linux systems (tested | The following steps describe an installation on Linux systems (tested
@ -396,7 +396,7 @@ Dev environment
$ git clone https://github.com/SamR1/FitTrackee.git $ git clone https://github.com/SamR1/FitTrackee.git
$ cd FitTrackee $ cd FitTrackee
- Create **Makefile.custom.config** from example and update it - Create **.env** from example and update it
(see `Environment variables <installation.html#environment-variables>`__). (see `Environment variables <installation.html#environment-variables>`__).
- Install Python virtualenv, React and all related packages and - Install Python virtualenv, React and all related packages and
@ -429,16 +429,16 @@ Production environment
.. warning:: .. warning::
| Note that FitTrackee is under heavy development, some features may be unstable. | Note that FitTrackee is under heavy development, some features may be unstable.
- Download the last release (for now, it is the release v0.4.0): - Download the last release (for now, it is the release v0.4.8):
.. code:: bash .. code:: bash
$ wget https://github.com/SamR1/FitTrackee/archive/v0.4.0.tar.gz $ wget https://github.com/SamR1/FitTrackee/archive/v0.4.8.tar.gz
$ tar -xzf v0.4.0.tar.gz $ tar -xzf v0.4.8.tar.gz
$ mv FitTrackee-0.4.0 FitTrackee $ mv FitTrackee-0.4.8 FitTrackee
$ cd FitTrackee $ cd FitTrackee
- Create **Makefile.custom.config** from example and update it - Create **.env** from example and update it
(see `Environment variables <installation.html#environment-variables>`__). (see `Environment variables <installation.html#environment-variables>`__).
- Install Python virtualenv and all related packages: - Install Python virtualenv and all related packages:
@ -512,7 +512,7 @@ Prod environment
$ git pull $ git pull
- Update **Makefile.custom.config** if needed - Update **.env** if needed
- Upgrade packages and database: - Upgrade packages and database:

12
docsrc/source/troubleshooting/administrator.rst
View File

@ -2,9 +2,13 @@ Administrator
############# #############
`JSON.parse: unexpected character at line 1 column 1 of the JSON data` `FitTrackee fails to start`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
On the **Network Tab**, if the requests are made to `http://localhost:3000/undefined/api`, that means the environnement variable **REACT_APP_API_URL** is not initialized. - Check the database URL in `Environment variables <../installation.html#envvar-DATABASE_URL>`__ if the following error is displayed in **gunicorn** logs:
Check if **Makefile.custom.config** file exists and **REACT_APP_API_URL** is correctly initialized (see `example <https://github.com/SamR1/FitTrackee/blob/master/Makefile.custom.config.example>`__), and rebuild the client. .. code::
sqlalchemy.exc.NoSuchModuleError: Can't load plugin: sqlalchemy.dialects:postgres
It must start with `postgresql://` (engine URLs starting with `postgres://` are no longer supported).