aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/de/user/upgrade.rst2
-rw-r--r--docs/en/developer/console_commands.rst30
-rw-r--r--docs/en/developer/front_end.rst33
-rw-r--r--docs/en/user/upgrade.rst2
-rw-r--r--docs/fr/developer/console_commands.rst30
-rw-r--r--docs/fr/developer/front-end.rst33
-rw-r--r--docs/fr/user/upgrade.rst2
-rw-r--r--docs/it/user/installation.rst2
-rw-r--r--docs/it/user/upgrade.rst2
9 files changed, 131 insertions, 5 deletions
diff --git a/docs/de/user/upgrade.rst b/docs/de/user/upgrade.rst
index af3b96fb..fa2aac45 100644
--- a/docs/de/user/upgrade.rst
+++ b/docs/de/user/upgrade.rst
@@ -61,7 +61,7 @@ Lade das letzte Release von wallabag herunter:
61 61
62.. code-block:: bash 62.. code-block:: bash
63 63
64 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 64 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
65 65
66Du findest den `aktuellen MD5-Hash auf unserer Webseite <https://static.wallabag.org/releases/>`_. 66Du findest den `aktuellen MD5-Hash auf unserer Webseite <https://static.wallabag.org/releases/>`_.
67 67
diff --git a/docs/en/developer/console_commands.rst b/docs/en/developer/console_commands.rst
new file mode 100644
index 00000000..85a8a092
--- /dev/null
+++ b/docs/en/developer/console_commands.rst
@@ -0,0 +1,30 @@
1Console Commands
2================
3
4wallabag has a number of CLI commands to manage a number of tasks. You can list all the commands by executing `bin/console` in the wallabag folder.
5
6Each command has a help accessible through `bin/console help %command%`.
7
8.. note::
9
10 If you're in a production environment, remember to add `-e prod` to each command.
11
12Notable commands
13----------------
14
15* `assets:install`: May be helpful if assets are missing.
16* `cache:clear`: should be run after each update (included in `make update`).
17* `doctrine:migrations:status`: Output the status of your database migrations.
18* `fos:user:activate`: Manually activate an user.
19* `fos:user:change-password`: Change a password for an user.
20* `fos:user:create`: Create an user.
21* `fos:user:deactivate`: Deactivate an user (not deleted).
22* `fos:user:demote`: Removes a role from an user, typically admin rights.
23* `fos:user:promote`: Adds a role to an user, typically admin rights.
24* `rabbitmq:*`: May be useful if you're using RabbitMQ.
25* `wallabag:clean-duplicates`: Removes all entry duplicates for one user or all users
26* `wallabag:export`: Exports all entries for an user. You can choose the output path of the file.
27* `wallabag:import`: Import entries to different formats to an user account.
28* `wallabag:import:redis-worker`: Useful if you use Redis.
29* `wallabag:install`: (re)Install wallabag
30* `wallabag:tag:all`: Tag all entries for an user using his/her tagging rules.
diff --git a/docs/en/developer/front_end.rst b/docs/en/developer/front_end.rst
new file mode 100644
index 00000000..40f18a42
--- /dev/null
+++ b/docs/en/developer/front_end.rst
@@ -0,0 +1,33 @@
1Tips for front-end developers
2=============================
3
4Starting from version 2.3, wallabag uses webpack to bundle its assets.
5
6Dev mode
7--------
8
9If the server runs in dev mode, you need to run ``yarn run build:dev`` to generate the outputted javascript files for each theme. These are named ``%theme%.dev.js`` and are ignored by git. You need to relaunch ``yarn run build:dev`` for each change made to one of the assets files (js, css, pictures, fonts,...).
10
11Live reload
12-----------
13
14Webpack brings support for live reload, which means you don't need to regenerate the assets file for each change neither reload the page manually. Changes are applied automatically in the web page. Just set the ``use_webpack_dev_server`` setting to ``true`` in ``app/config/config.yml`` and run ``yarn run watch`` and you're good to go.
15
16.. note::
17
18 Don't forget to put back ``use_webpack_dev_server`` to ``false`` when not using the live reload feature.
19
20Production builds
21-----------------
22
23When you want to commit your changes, build them in production environment by using ``yarn run build:prod``. This will build all the assets needed for wallabag. To test that it properly works, you'll need to have a server in production mode, for instance with ``bin/console server:run -e=prod``.
24
25.. note::
26
27 Don't forget to generate production builds before committing !
28
29
30Code style
31----------
32
33Code style is checked by two tools : stylelint for (S)CSS and eslint for JS. ESlint config is based on the Airbnb base preset.
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst
index 359a355f..3157684c 100644
--- a/docs/en/user/upgrade.rst
+++ b/docs/en/user/upgrade.rst
@@ -65,7 +65,7 @@ Download the last release of wallabag:
65 65
66.. code-block:: bash 66.. code-block:: bash
67 67
68 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 68 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
69 69
70You will find the `md5 hash of the latest package on our website <https://static.wallabag.org/releases/>`_. 70You will find the `md5 hash of the latest package on our website <https://static.wallabag.org/releases/>`_.
71 71
diff --git a/docs/fr/developer/console_commands.rst b/docs/fr/developer/console_commands.rst
new file mode 100644
index 00000000..1b222b32
--- /dev/null
+++ b/docs/fr/developer/console_commands.rst
@@ -0,0 +1,30 @@
1Actions en ligne de commande
2============================
3
4wallabag a un certain nombre de commandes CLI pour effectuer des tâches. Vous pouvez lister toutes les commandes en exécutant `bin/console` dans le dossier d'installation de wallabag.
5
6Chaque commande a une aide correspondante accessible via `bin/console help %command%`.
7
8.. note::
9
10 Si vous êtes dans un environnement de production, souvenez-vous d'ajouter `-e prod` à chaque commande.
11
12Commandes notables
13------------------
14
15* `assets:install`: Peut-être utile si les *assets* sont manquants.
16* `cache:clear`: doit être exécuté après chaque mise à jour (appelé dans `make update`).
17* `doctrine:migrations:status`: Montre le statut de vos migrations de vos bases de données.
18* `fos:user:activate`: Activer manuellement un utilisateur.
19* `fos:user:change-password`: Changer le mot de passe pour un utilisateur.
20* `fos:user:create`: Créer un utilisateur.
21* `fos:user:deactivate`: Désactiver un utilisateur (non supprimé).
22* `fos:user:demote`: Supprimer un rôle d'un utilisateur, typiquement les droits d'administration.
23* `fos:user:promote`: Ajoute un rôle à un utilisateur, typiquement les droits d'administration.
24* `rabbitmq:*`: Peut-être utile si vous utilisez RabbitMQ.
25* `wallabag:clean-duplicates`: Supprime tous les articles dupliqués pour un utilisateur ou bien tous.
26* `wallabag:export`: Exporte tous les articles pour un utilisateur. Vous pouvez choisir le chemin du fichier exporté.
27* `wallabag:import`: Importe les articles en différents formats dans un compte utilisateur.
28* `wallabag:import:redis-worker`: Utile si vous utilisez Redis.
29* `wallabag:install`: (ré)Installer wallabag
30* `wallabag:tag:all`: Tagger tous les articles pour un utilisateur ou une utilisatrice en utilisant ses règles de tags automatiques.
diff --git a/docs/fr/developer/front-end.rst b/docs/fr/developer/front-end.rst
new file mode 100644
index 00000000..714df08b
--- /dev/null
+++ b/docs/fr/developer/front-end.rst
@@ -0,0 +1,33 @@
1Conseils pour développeurs front-end
2====================================
3
4Depuis la version 2.3, wallabag utilise webpack pour générer ses assets.
5
6Mode développeur
7----------------
8
9Si le serveur fonctionne en mode dev, vous devez lancer la commande ``yarn run build:dev`` pour générer les fichiers de sortie javascript pour chaque thème. Ils sont nommés ``%theme%.dev.js`` et sont ignorés par git. Vous devez relancer la commande ``yarn run build:dev`` pour chaque changement que vous effectuez dans les fichiers assets (js, css, images, polices,...).
10
11Live reload
12-----------
13
14Webpack apporte le support pour la fonctionnalité de live reload, ce qui signifie que vous n'avez pas besoin de regénérer manuellement le fichier de sortie javascript ni de rafraichir la page dans votre navigateur. Les changements sont appliqués automatiquement. Vous avez juste besoin de mettre le paramètre ``use_webpack_dev_server`` à ``true`` dans ``app/config/config.yml`` et de lancer ``yarn run watch`` pour que cela soit actif.
15
16.. note::
17
18 N'oubliez pas de remettre ``use_webpack_dev_server`` à ``false`` lorsque vous n'utilisez pas la fonctionnalité de live reload.
19
20Production builds
21-----------------
22
23Lorsque vous committez vos changements, vous devez les compiler dans un environnement de production en exécutant ``yarn run build:prod``. Cela compilera tous les assets nécessaires pour wallabag. Pour tester que cela fonctionne proprement, vous devrez avoir un serveur en mode de production, par exemple avec ``bin/console server:run -e=prod``.
24
25.. note::
26
27 N'oubliez pas de générer des fichiers en mode production avant de committer !
28
29
30Code style
31----------
32
33Le style de code est vérifié par deux outils : stylelint pour le (S)CSS et eslint pour le JS. La configuration ESlint config est basée sur le preset Airbnb base.
diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade.rst
index 5bb42deb..af198006 100644
--- a/docs/fr/user/upgrade.rst
+++ b/docs/fr/user/upgrade.rst
@@ -61,7 +61,7 @@ Téléchargez la dernière version de wallabag :
61 61
62.. code-block:: bash 62.. code-block:: bash
63 63
64 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 64 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
65 65
66Vous trouverez `le hash md5 du dernier package sur notre site <https://static.wallabag.org/releases/>`_. 66Vous trouverez `le hash md5 du dernier package sur notre site <https://static.wallabag.org/releases/>`_.
67 67
diff --git a/docs/it/user/installation.rst b/docs/it/user/installation.rst
index c067228d..174507b8 100644
--- a/docs/it/user/installation.rst
+++ b/docs/it/user/installation.rst
@@ -86,7 +86,7 @@ Eseguite questo comando per scaricare ed estrarre il pacchetto piú aggiornato:
86 86
87.. code-block:: bash 87.. code-block:: bash
88 88
89 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 89 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
90 90
91Troverete il `hash md5 del pacchetto piú aggiornato sul nostro sito <https://static.wallabag.org/releases/>`_. 91Troverete il `hash md5 del pacchetto piú aggiornato sul nostro sito <https://static.wallabag.org/releases/>`_.
92 92
diff --git a/docs/it/user/upgrade.rst b/docs/it/user/upgrade.rst
index 52cd98c7..ede1a1a3 100644
--- a/docs/it/user/upgrade.rst
+++ b/docs/it/user/upgrade.rst
@@ -78,7 +78,7 @@ Scaricate l'ultima versione di wallabag:
78 78
79. code-block:: bash 79. code-block:: bash
80 80
81 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 81 wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package
82 82
83Troverete il `hash md5 dell'ultima versione del pacchetto sul nostro sito <https://static.wallabag.org/releases/>`_. 83Troverete il `hash md5 dell'ultima versione del pacchetto sul nostro sito <https://static.wallabag.org/releases/>`_.
84 84