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 2020-07-15 17:19:37 +02:00
parent 404bf286ef
commit 78b11120ec
14 changed files with 46 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -1,10 +1,10 @@
# Change log # Change log
## Version 0.3.0 - Administration (2020/07/xx) ## Version 0.3.0 - Administration (2020/07/15)
This version introduces some major changes: This version introduces some major changes:
- FitTrackee administration is now available (see [documentation](https://samr1.github.io/FitTrackee/features.html#administration)) - FitTrackee administration is now available (see [documentation](https://samr1.github.io/FitTrackee/features.html#administration))
Note: some application parameters move from environment variables to database (see [installation](https://samr1.github.io/FitTrackee/installation.html#environment-variables)). ⚠️ Warning: some application parameters move from environment variables to database (see [installation](https://samr1.github.io/FitTrackee/installation.html#environment-variables)).
- in order to send emails, Redis is now a mandatory dependency - in order to send emails, Redis is now a mandatory dependency
### Issues Closed ### Issues Closed

2
README.md
View File

@ -17,6 +17,8 @@ No mobile app is developed yet, but several existing mobile apps can store worko
Examples (for Android): Examples (for Android):
* [Runner Up](https://github.com/jonasoreland/runnerup) (GPL v3) * [Runner Up](https://github.com/jonasoreland/runnerup) (GPL v3)
* [ForRunners](https://gitlab.com/brvier/ForRunners) (GPL v3) * [ForRunners](https://gitlab.com/brvier/ForRunners) (GPL v3)
* [OpenTracks](https://github.com/OpenTracksApp/OpenTracks) (Apache License)
* [FitoTrack](https://codeberg.org/jannis/FitoTrack) (GPL v3)
* [AlpineQuest](https://www.alpinequest.net/) (Proprietary, no trackers according to [exodus privay report](https://reports.exodus-privacy.eu.org/en/reports/search/psyberia.alpinequest.free/)) * [AlpineQuest](https://www.alpinequest.net/) (Proprietary, no trackers according to [exodus privay report](https://reports.exodus-privacy.eu.org/en/reports/search/psyberia.alpinequest.free/))
Maps are displayed using [Open Street Map](https://www.openstreetmap.org). Maps are displayed using [Open Street Map](https://www.openstreetmap.org).

4
docs/_sources/changelog.md.txt
View File

@ -1,10 +1,10 @@
# Change log # Change log
## Version 0.3.0 - Administration (2020/07/xx) ## Version 0.3.0 - Administration (2020/07/15)
This version introduces some major changes: This version introduces some major changes:
- FitTrackee administration is now available (see [documentation](https://samr1.github.io/FitTrackee/features.html#administration)) - FitTrackee administration is now available (see [documentation](https://samr1.github.io/FitTrackee/features.html#administration))
Note: some application parameters move from environment variables to database (see [installation](https://samr1.github.io/FitTrackee/installation.html#environment-variables)). ⚠️ Warning: some application parameters move from environment variables to database (see [installation](https://samr1.github.io/FitTrackee/installation.html#environment-variables)).
- in order to send emails, Redis is now a mandatory dependency - in order to send emails, Redis is now a mandatory dependency
### Issues Closed ### Issues Closed

13
docs/_sources/features.rst.txt
View File

@ -11,20 +11,22 @@ Account
Administration Administration
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
- Application - **Application**
The following parameters can be set:
- active users limit (if 0, registration is enabled (no limit defined)) - active users limit (if 0, registration is enabled (no limit defined))
- maximum size of uploaded files - maximum size of uploaded files
- maximum size of zip archive - maximum size of zip archive
- maximum number of files in the zip archive - maximum number of files in the zip archive
- Users - **Users**
- display users list and details - display users list and details
- edit a user to add/remove administration rights - edit a user to add/remove administration rights
- delete a user - delete a user
- Sports - **Sports**
- enable or disable a sport (a sport can be disabled even if activity with this sport exists) - enable or disable a sport (a sport can be disabled even if activity with this sport exists)
@ -49,9 +51,8 @@ Activities/Workouts
- maximum speed - maximum speed
- Activities list and filter - Activities list and filter
**Notes:** .. note::
for now, only the owner of the activity can see the activity.
- for now, only activity owner can see his activities
Translations Translations
^^^^^^^^^^^^ ^^^^^^^^^^^^

2
docs/_sources/index.rst.txt
View File

@ -12,6 +12,8 @@ FitTrackee
| Examples (for Android): | Examples (for Android):
| \* `Runner Up <https://github.com/jonasoreland/runnerup>`_ (GPL v3) | \* `Runner Up <https://github.com/jonasoreland/runnerup>`_ (GPL v3)
| \* `ForRunners <https://gitlab.com/brvier/ForRunners>`_ (GPL v3) | \* `ForRunners <https://gitlab.com/brvier/ForRunners>`_ (GPL v3)
| \* `OpenTracks <https://github.com/OpenTracksApp/OpenTracks>`_ (Apache License)
| \* `FitoTrack <https://codeberg.org/jannis/FitoTrack>`_ (GPL v3)
| \* `AlpineQuest <https://www.alpinequest.net/>`_ (Proprietary, no | \* `AlpineQuest <https://www.alpinequest.net/>`_ (Proprietary, no
trackers according to `exodus privay trackers according to `exodus privay
report <https://reports.exodus-privacy.eu.org/en/reports/search/psyberia.alpinequest.free/>`_) report <https://reports.exodus-privacy.eu.org/en/reports/search/psyberia.alpinequest.free/>`_)

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

@ -204,7 +204,7 @@ variable description ap
.. warning:: .. warning::
Since FitTrackee 0.3.0, some applications parameters are now stored in database. Since FitTrackee 0.3.0, some applications parameters are now stored in database.
Related environement variables are needed to initialize database. Related environment variables are needed to initialize database.
Emails Emails
^^^^^^ ^^^^^^

8
docs/changelog.html
View File

@ -76,7 +76,7 @@
role="menu" role="menu"
aria-labelledby="dLabelLocalToc"><ul> aria-labelledby="dLabelLocalToc"><ul>
<li><a class="reference internal" href="#">Change log</a><ul> <li><a class="reference internal" href="#">Change log</a><ul>
<li><a class="reference internal" href="#version-0-3-0-administration-2020-07-xx">Version 0.3.0 - Administration (2020/07/xx)</a><ul> <li><a class="reference internal" href="#version-0-3-0-administration-2020-07-15">Version 0.3.0 - Administration (2020/07/15)</a><ul>
<li><a class="reference internal" href="#issues-closed">Issues Closed</a><ul> <li><a class="reference internal" href="#issues-closed">Issues Closed</a><ul>
<li><a class="reference internal" href="#new-features">New Features</a></li> <li><a class="reference internal" href="#new-features">New Features</a></li>
</ul> </ul>
@ -188,11 +188,11 @@
<div class="section" id="change-log"> <div class="section" id="change-log">
<h1>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1> <h1>Change log<a class="headerlink" href="#change-log" title="Permalink to this headline"></a></h1>
<div class="section" id="version-0-3-0-administration-2020-07-xx"> <div class="section" id="version-0-3-0-administration-2020-07-15">
<h2>Version 0.3.0 - Administration (2020/07/xx)<a class="headerlink" href="#version-0-3-0-administration-2020-07-xx" title="Permalink to this headline"></a></h2> <h2>Version 0.3.0 - Administration (2020/07/15)<a class="headerlink" href="#version-0-3-0-administration-2020-07-15" title="Permalink to this headline"></a></h2>
<p>This version introduces some major changes:</p> <p>This version introduces some major changes:</p>
<ul class="simple"> <ul class="simple">
<li><p>FitTrackee administration is now available (see <a class="reference external" href="https://samr1.github.io/FitTrackee/features.html#administration">documentation</a>)<br />Note: some application parameters move from environment variables to database (see <a class="reference external" href="https://samr1.github.io/FitTrackee/installation.html#environment-variables">installation</a>).</p></li> <li><p>FitTrackee administration is now available (see <a class="reference external" href="https://samr1.github.io/FitTrackee/features.html#administration">documentation</a>)<br />⚠️ Warning: some application parameters move from environment variables to database (see <a class="reference external" href="https://samr1.github.io/FitTrackee/installation.html#environment-variables">installation</a>).</p></li>
<li><p>in order to send emails, Redis is now a mandatory dependency</p></li> <li><p>in order to send emails, Redis is now a mandatory dependency</p></li>
</ul> </ul>
<div class="section" id="issues-closed"> <div class="section" id="issues-closed">

21
docs/features.html
View File

@ -151,24 +151,25 @@
</div> </div>
<div class="section" id="administration"> <div class="section" id="administration">
<h3>Administration<a class="headerlink" href="#administration" title="Permalink to this headline"></a></h3> <h3>Administration<a class="headerlink" href="#administration" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Application</p>
<ul> <ul>
<li><p><strong>Application</strong></p>
<p>The following parameters can be set:</p>
<ul class="simple">
<li><p>active users limit (if 0, registration is enabled (no limit defined))</p></li> <li><p>active users limit (if 0, registration is enabled (no limit defined))</p></li>
<li><p>maximum size of uploaded files</p></li> <li><p>maximum size of uploaded files</p></li>
<li><p>maximum size of zip archive</p></li> <li><p>maximum size of zip archive</p></li>
<li><p>maximum number of files in the zip archive</p></li> <li><p>maximum number of files in the zip archive</p></li>
</ul> </ul>
</li> </li>
<li><p>Users</p> <li><p><strong>Users</strong></p>
<ul> <ul class="simple">
<li><p>display users list and details</p></li> <li><p>display users list and details</p></li>
<li><p>edit a user to add/remove administration rights</p></li> <li><p>edit a user to add/remove administration rights</p></li>
<li><p>delete a user</p></li> <li><p>delete a user</p></li>
</ul> </ul>
</li> </li>
<li><p>Sports</p> <li><p><strong>Sports</strong></p>
<ul> <ul class="simple">
<li><p>enable or disable a sport (a sport can be disabled even if activity with this sport exists)</p></li> <li><p>enable or disable a sport (a sport can be disabled even if activity with this sport exists)</p></li>
</ul> </ul>
</li> </li>
@ -206,10 +207,10 @@
</li> </li>
<li><p>Activities list and filter</p></li> <li><p>Activities list and filter</p></li>
</ul> </ul>
<p><strong>Notes:</strong></p> <div class="admonition note">
<ul class="simple"> <p class="admonition-title">Note</p>
<li><p>for now, only activity owner can see his activities</p></li> <p>for now, only the owner of the activity can see the activity.</p>
</ul> </div>
</div> </div>
<div class="section" id="translations"> <div class="section" id="translations">
<h3>Translations<a class="headerlink" href="#translations" title="Permalink to this headline"></a></h3> <h3>Translations<a class="headerlink" href="#translations" title="Permalink to this headline"></a></h3>

4
docs/index.html
View File

@ -130,6 +130,8 @@ store workouts data locally and export them into a gpx file.</div>
<div class="line">Examples (for Android):</div> <div class="line">Examples (for Android):</div>
<div class="line">* <a class="reference external" href="https://github.com/jonasoreland/runnerup">Runner Up</a> (GPL v3)</div> <div class="line">* <a class="reference external" href="https://github.com/jonasoreland/runnerup">Runner Up</a> (GPL v3)</div>
<div class="line">* <a class="reference external" href="https://gitlab.com/brvier/ForRunners">ForRunners</a> (GPL v3)</div> <div class="line">* <a class="reference external" href="https://gitlab.com/brvier/ForRunners">ForRunners</a> (GPL v3)</div>
<div class="line">* <a class="reference external" href="https://github.com/OpenTracksApp/OpenTracks">OpenTracks</a> (Apache License)</div>
<div class="line">* <a class="reference external" href="https://codeberg.org/jannis/FitoTrack">FitoTrack</a> (GPL v3)</div>
<div class="line">* <a class="reference external" href="https://www.alpinequest.net/">AlpineQuest</a> (Proprietary, no <div class="line">* <a class="reference external" href="https://www.alpinequest.net/">AlpineQuest</a> (Proprietary, no
trackers according to <a class="reference external" href="https://reports.exodus-privacy.eu.org/en/reports/search/psyberia.alpinequest.free/">exodus privay trackers according to <a class="reference external" href="https://reports.exodus-privacy.eu.org/en/reports/search/psyberia.alpinequest.free/">exodus privay
report</a>)</div> report</a>)</div>
@ -183,7 +185,7 @@ Map</a>.</div>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Change log</a><ul> <li class="toctree-l1"><a class="reference internal" href="changelog.html">Change log</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-3-0-administration-2020-07-xx">Version 0.3.0 - Administration (2020/07/xx)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-3-0-administration-2020-07-15">Version 0.3.0 - Administration (2020/07/15)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-5-fix-and-improvements-2020-01-31">Version 0.2.5 - Fix and improvements (2020/01/31)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-5-fix-and-improvements-2020-01-31">Version 0.2.5 - Fix and improvements (2020/01/31)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-4-minor-fix-2020-01-30">Version 0.2.4 - Minor fix (2020/01/30)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-4-minor-fix-2020-01-30">Version 0.2.4 - Minor fix (2020/01/30)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-3-fittrackee-available-in-french-2019-12-29">Version 0.2.3 - FitTrackee available in French (2019/12/29)</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-2-3-fittrackee-available-in-french-2019-12-29">Version 0.2.3 - FitTrackee available in French (2019/12/29)</a></li>

2
docs/installation.html
View File

@ -389,7 +389,7 @@ $ make upgrade-db
<div class="admonition warning"> <div class="admonition warning">
<p class="admonition-title">Warning</p> <p class="admonition-title">Warning</p>
<p>Since FitTrackee 0.3.0, some applications parameters are now stored in database. <p>Since FitTrackee 0.3.0, some applications parameters are now stored in database.
Related environement variables are needed to initialize database.</p> Related environment variables are needed to initialize database.</p>
</div> </div>
<div class="section" id="emails"> <div class="section" id="emails">
<h3>Emails<a class="headerlink" href="#emails" title="Permalink to this headline"></a></h3> <h3>Emails<a class="headerlink" href="#emails" title="Permalink to this headline"></a></h3>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

13
docsrc/source/features.rst
View File

@ -11,20 +11,22 @@ Account
Administration Administration
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
- Application - **Application**
The following parameters can be set:
- active users limit (if 0, registration is enabled (no limit defined)) - active users limit (if 0, registration is enabled (no limit defined))
- maximum size of uploaded files - maximum size of uploaded files
- maximum size of zip archive - maximum size of zip archive
- maximum number of files in the zip archive - maximum number of files in the zip archive
- Users - **Users**
- display users list and details - display users list and details
- edit a user to add/remove administration rights - edit a user to add/remove administration rights
- delete a user - delete a user
- Sports - **Sports**
- enable or disable a sport (a sport can be disabled even if activity with this sport exists) - enable or disable a sport (a sport can be disabled even if activity with this sport exists)
@ -49,9 +51,8 @@ Activities/Workouts
- maximum speed - maximum speed
- Activities list and filter - Activities list and filter
**Notes:** .. note::
for now, only the owner of the activity can see the activity.
- for now, only activity owner can see his activities
Translations Translations
^^^^^^^^^^^^ ^^^^^^^^^^^^

2
docsrc/source/index.rst
View File

@ -12,6 +12,8 @@ FitTrackee
| Examples (for Android): | Examples (for Android):
| \* `Runner Up <https://github.com/jonasoreland/runnerup>`_ (GPL v3) | \* `Runner Up <https://github.com/jonasoreland/runnerup>`_ (GPL v3)
| \* `ForRunners <https://gitlab.com/brvier/ForRunners>`_ (GPL v3) | \* `ForRunners <https://gitlab.com/brvier/ForRunners>`_ (GPL v3)
| \* `OpenTracks <https://github.com/OpenTracksApp/OpenTracks>`_ (Apache License)
| \* `FitoTrack <https://codeberg.org/jannis/FitoTrack>`_ (GPL v3)
| \* `AlpineQuest <https://www.alpinequest.net/>`_ (Proprietary, no | \* `AlpineQuest <https://www.alpinequest.net/>`_ (Proprietary, no
trackers according to `exodus privay trackers according to `exodus privay
report <https://reports.exodus-privacy.eu.org/en/reports/search/psyberia.alpinequest.free/>`_) report <https://reports.exodus-privacy.eu.org/en/reports/search/psyberia.alpinequest.free/>`_)

2
docsrc/source/installation.rst
View File

@ -204,7 +204,7 @@ variable description ap
.. warning:: .. warning::
Since FitTrackee 0.3.0, some applications parameters are now stored in database. Since FitTrackee 0.3.0, some applications parameters are now stored in database.
Related environement variables are needed to initialize database. Related environment variables are needed to initialize database.
Emails Emails
^^^^^^ ^^^^^^