update documentation
This commit is contained in:
parent
6ab8586781
commit
8de2b4d475
@ -17,13 +17,22 @@ First off, thank you for your interest in contributing!
|
|||||||
|
|
||||||
The **GitHub** repository contains:
|
The **GitHub** repository contains:
|
||||||
- source code (note that the repository also includes client build),
|
- source code (note that the repository also includes client build),
|
||||||
|
- translations,
|
||||||
- tests,
|
- tests,
|
||||||
- documentation (source and build).
|
- documentation (source and build).
|
||||||
|
|
||||||
Translations can be updated through [Weblate](https://hosted.weblate.org/engage/fittrackee/).
|
|
||||||
|
|
||||||
Continuous integration workflows run on **Github Actions** platform (on **push** and **pull requests**).
|
Continuous integration workflows run on **Github Actions** platform (on **push** and **pull requests**).
|
||||||
|
|
||||||
|
### Translations
|
||||||
|
|
||||||
|
The available languages are:
|
||||||
|
[![Translation status](https://hosted.weblate.org/widgets/fittrackee/-/multi-auto.svg)](https://hosted.weblate.org/engage/fittrackee/)
|
||||||
|
|
||||||
|
Translations files are located:
|
||||||
|
- on API side (emails): `fittrackee/emails/translations/` (implemented with [Babel](https://babel.pocoo.org/en/latest/))
|
||||||
|
- on client side: `fittrackee_client/src/locales` (implemented with [Vue I18n](https://vue-i18n.intlify.dev/))
|
||||||
|
|
||||||
|
Translations can be updated through [Weblate](https://hosted.weblate.org/engage/fittrackee/).
|
||||||
|
|
||||||
### How to install FitTrackee
|
### How to install FitTrackee
|
||||||
|
|
||||||
@ -62,14 +71,30 @@ Please make your changes from the development branch (`dev`).
|
|||||||
$ make test-e2e
|
$ make test-e2e
|
||||||
```
|
```
|
||||||
|
|
||||||
|
* If needed, update translations.
|
||||||
|
* On client side, update files in `fittrackee_client/src/locales` folder.
|
||||||
|
* On API side (emails), to extract new strings into `messages.pot`:
|
||||||
|
```shell
|
||||||
|
$ make babel-extract
|
||||||
|
```
|
||||||
|
To add new strings in translations files (`fittrackee/emails/translations/<LANG>/LC_MESSAGES/messages.po`):
|
||||||
|
```shell
|
||||||
|
$ make babel-update
|
||||||
|
```
|
||||||
|
After updating strings in `messages.po`, compile the translations:
|
||||||
|
```shell
|
||||||
|
$ make babel-compile
|
||||||
|
```
|
||||||
|
|
||||||
* If needed, add or update tests.
|
* If needed, add or update tests.
|
||||||
|
|
||||||
* If needed, update documentation (no need to build documentation, it will be done when releasing).
|
* If needed, update documentation (no need to build documentation, it will be done when releasing).
|
||||||
|
|
||||||
* If updated code contains client-side changes, you can generate a build, in a **separate commit** to ease code review (or to easily drop it in case of conflicts when updating your branch).
|
* If updated code contains client-side changes, you can generate javascript assets to check **FitTrackee** whithout starting client dev server:
|
||||||
```shell
|
```shell
|
||||||
$ make build-client
|
$ make build-client
|
||||||
```
|
```
|
||||||
|
No need to commit these files, dist files will be generated before merging or when releasing.
|
||||||
|
|
||||||
* Create your pull request to merge on `dev` branch.
|
* Create your pull request to merge on `dev` branch.
|
||||||
|
|
||||||
|
@ -119,7 +119,9 @@ Administration
|
|||||||
|
|
||||||
Translations
|
Translations
|
||||||
^^^^^^^^^^^^
|
^^^^^^^^^^^^
|
||||||
FitTrackee is available in English and French (which can be saved in the user preferences).
|
FitTrackee is available in the following languages (which can be saved in the user preferences):
|
||||||
|
|
||||||
|
.. figure:: https://hosted.weblate.org/widgets/fittrackee/-/multi-auto.svg
|
||||||
|
|
||||||
|
|
||||||
Screenshots
|
Screenshots
|
||||||
|
@ -313,7 +313,9 @@ A user with an inactive account cannot log in. (<em>new in 0.6.0</em>)</p></li>
|
|||||||
</section>
|
</section>
|
||||||
<section id="translations">
|
<section id="translations">
|
||||||
<h2>Translations<a class="headerlink" href="#translations" title="Permalink to this heading">¶</a></h2>
|
<h2>Translations<a class="headerlink" href="#translations" title="Permalink to this heading">¶</a></h2>
|
||||||
<p>FitTrackee is available in English and French (which can be saved in the user preferences).</p>
|
<p>FitTrackee is available in the following languages (which can be saved in the user preferences):</p>
|
||||||
|
<figure class="align-default">
|
||||||
|
<img alt="https://hosted.weblate.org/widgets/fittrackee/-/multi-auto.svg" src="https://hosted.weblate.org/widgets/fittrackee/-/multi-auto.svg" /></figure>
|
||||||
</section>
|
</section>
|
||||||
<section id="screenshots">
|
<section id="screenshots">
|
||||||
<h2>Screenshots<a class="headerlink" href="#screenshots" title="Permalink to this heading">¶</a></h2>
|
<h2>Screenshots<a class="headerlink" href="#screenshots" title="Permalink to this heading">¶</a></h2>
|
||||||
|
File diff suppressed because one or more lines are too long
@ -119,7 +119,9 @@ Administration
|
|||||||
|
|
||||||
Translations
|
Translations
|
||||||
^^^^^^^^^^^^
|
^^^^^^^^^^^^
|
||||||
FitTrackee is available in English and French (which can be saved in the user preferences).
|
FitTrackee is available in the following languages (which can be saved in the user preferences):
|
||||||
|
|
||||||
|
.. figure:: https://hosted.weblate.org/widgets/fittrackee/-/multi-auto.svg
|
||||||
|
|
||||||
|
|
||||||
Screenshots
|
Screenshots
|
||||||
|
Loading…
Reference in New Issue
Block a user