From 322c270b6590d0d0bf5025f4782ffe7cdea0f8b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 16 May 2017 13:09:40 +0200 Subject: Removed embedded documentation --- docs/fr/developer/api.rst | 271 --------------------------------- docs/fr/developer/asynchronous.rst | 160 ------------------- docs/fr/developer/console_commands.rst | 30 ---- docs/fr/developer/docker.rst | 50 ------ docs/fr/developer/documentation.rst | 12 -- docs/fr/developer/front-end.rst | 33 ---- docs/fr/developer/paywall.rst | 65 -------- docs/fr/developer/testsuite.rst | 10 -- docs/fr/developer/translate.rst | 62 -------- 9 files changed, 693 deletions(-) delete mode 100644 docs/fr/developer/api.rst delete mode 100644 docs/fr/developer/asynchronous.rst delete mode 100644 docs/fr/developer/console_commands.rst delete mode 100644 docs/fr/developer/docker.rst delete mode 100644 docs/fr/developer/documentation.rst delete mode 100644 docs/fr/developer/front-end.rst delete mode 100644 docs/fr/developer/paywall.rst delete mode 100644 docs/fr/developer/testsuite.rst delete mode 100644 docs/fr/developer/translate.rst (limited to 'docs/fr/developer') diff --git a/docs/fr/developer/api.rst b/docs/fr/developer/api.rst deleted file mode 100644 index e7bb264f..00000000 --- a/docs/fr/developer/api.rst +++ /dev/null @@ -1,271 +0,0 @@ -Documentation de l'API -====================== - -Grâce à cette documentation, nous allons voir comment interagir avec l'API de wallabag. - -Pré-requis ----------- - -* wallabag fraichement installé et disponible à http://localhost:8000 -* ``httpie`` installé sur votre ordinateur (`voir le site du projet `__). Vous pouvez également adapter les commandes en utilisant curl ou wget. -* toutes les méthodes de l'API documentées ici http://localhost:8000/api/doc - -Créer un nouveau client d'API ------------------------------ - -Depuis votre wallabag, vous pouvez créer un nouveau client d'API à cette URL http://localhost:8000/developer/client/create. - -Vous devez renseigner l'URL de redirection de votre application et créer votre client. Si votre application est une application desktop, renseignez l'URL que vous souhaitez. - -Vous obtiendrez les informations suivantes : - -:: - - Client ID: - - 1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc - - Client secret: - - 636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 - - -Créer un jeton --------------- - -Pour chaque appel d'API, vous aurez besoin d'un jeton. Créons-le avec la commande suivante (remplacez ``client_id``, ``client_secret``, ``username`` and ``password`` par leur valeur): - -:: - - http POST http://localhost:8000/oauth/v2/token \ - grant_type=password \ - client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \ - client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \ - username=wallabag \ - password=wallabag - -Vous obtiendrez : - -:: - - HTTP/1.1 200 OK - Cache-Control: no-store, private - Connection: close - Content-Type: application/json - Date: Tue, 05 Apr 2016 08:44:33 GMT - Host: localhost:8000 - Pragma: no-cache - X-Debug-Token: 19c8e0 - X-Debug-Token-Link: /_profiler/19c8e0 - X-Powered-By: PHP/7.0.4 - - { - "access_token": "ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA", - "expires_in": 3600, - "refresh_token": "OTNlZGE5OTJjNWQwYzc2NDI5ZGE5MDg3ZTNjNmNkYTY0ZWZhZDVhNDBkZTc1ZTNiMmQ0MjQ0OThlNTFjNTQyMQ", - "scope": null, - "token_type": "bearer" - } - -Nous allons utiliser la valeur de ``access_token`` dans nos prochains appels. - -Exemple cURL : - -:: - - curl -s "https://localhost:8000/oauth/v2/token?grant_type=password&client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc&client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4&username=wallabag&password=wallabag" - -Récupérer les articles existants --------------------------------- - -Documentation pour cette méthode : http://localhost:8000/api/doc#get--api-entries.{_format} - -Comme nous venons tout juste d'installer wallabag, nous n'aurons aucun résultat avec cette commande : - -:: - - http GET http://localhost:8000/api/entries.json \ - "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -retournera : - -:: - - HTTP/1.1 200 OK - 0: application/json - Cache-Control: no-cache - Connection: close - Content-Type: application/json - Date: Tue, 05 Apr 2016 08:51:32 GMT - Host: localhost:8000 - Set-Cookie: PHPSESSID=nrogm748md610ovhu6j70c3q63; path=/; HttpOnly - X-Debug-Token: 4fbbc4 - X-Debug-Token-Link: /_profiler/4fbbc4 - X-Powered-By: PHP/7.0.4 - - { - "_embedded": { - "items": [] - }, - "_links": { - "first": { - "href": "http://localhost:8000/api/entries?page=1&perPage=30" - }, - "last": { - "href": "http://localhost:8000/api/entries?page=1&perPage=30" - }, - "self": { - "href": "http://localhost:8000/api/entries?page=1&perPage=30" - } - }, - "limit": 30, - "page": 1, - "pages": 1, - "total": 0 - } - -Le tableau ``items`` est vide. - -Exemple cURL : - -:: - - curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -Créer votre premier article ---------------------------- - -Documentation pour cette méthode : http://localhost:8000/api/doc#post--api-entries.{_format} - -:: - - http POST http://localhost:8000/api/entries.json \ - "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" \ - url="http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html" - -retournera : - -:: - - HTTP/1.1 200 OK - 0: application/json - Cache-Control: no-cache - Connection: close - Content-Type: application/json - Date: Tue, 05 Apr 2016 09:07:54 GMT - Host: localhost:8000 - Set-Cookie: PHPSESSID=bjie40ck72kp2pst3i71gf43a4; path=/; HttpOnly - X-Debug-Token: e01c51 - X-Debug-Token-Link: /_profiler/e01c51 - X-Powered-By: PHP/7.0.4 - - { - "_links": { - "self": { - "href": "/api/entries/1" - } - }, - "content": "

Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.

Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’une fonctionnalité intitulée Pocket. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.

\n

Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.

\n

Mais Pocket fait polémique, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme Wallabag, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.

\n

Et justement, Wallabag évolue. C’est ce dimanche que la version 2.0.0 du logiciel a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la documentation est traduite en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.

\n

\"homepage\"

\n

Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.

\n

D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.

\n \n \n

Articles liés

\n
\n
\n", - "created_at": "2016-04-05T09:07:54+0000", - "domain_name": "www.numerama.com", - "id": 1, - "is_archived": 0, - "is_starred": 0, - "language": "fr-FR", - "mimetype": "text/html", - "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", - "reading_time": 2, - "tags": [], - "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", - "updated_at": "2016-04-05T09:07:54+0000", - "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", - "user_email": "", - "user_id": 1, - "user_name": "wallabag" - } - -Maintenant, si vous exécutez la précédente commande (voir **Récupérer les articles existants**), vous obtiendrez quelque chose. - -Exemple cURL : - -:: - - curl "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA&url=http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html" - -Supprimer un article --------------------- - -Documentation pour cette méthode : http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format} - -:: - - http DELETE http://localhost:8000/api/entries/1.json \ - "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -retournera : - -:: - - HTTP/1.1 200 OK - 0: application/json - Cache-Control: no-cache - Connection: close - Content-Type: application/json - Date: Tue, 05 Apr 2016 09:19:07 GMT - Host: localhost:8000 - Set-Cookie: PHPSESSID=jopgnfvmuc9a62b27sqm6iulr6; path=/; HttpOnly - X-Debug-Token: 887cef - X-Debug-Token-Link: /_profiler/887cef - X-Powered-By: PHP/7.0.4 - - { - "_links": { - "self": { - "href": "/api/entries/" - } - }, - "annotations": [], - "content": "

Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.

Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’une fonctionnalité intitulée Pocket. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.

\n

Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.

\n

Mais Pocket fait polémique, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme Wallabag, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.

\n

Et justement, Wallabag évolue. C’est ce dimanche que la version 2.0.0 du logiciel a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la documentation est traduite en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.

\n

\"homepage\"

\n

Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.

\n

D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.

\n \n \n

Articles liés

\n
\n
\n", - "created_at": "2016-04-05T09:07:54+0000", - "domain_name": "www.numerama.com", - "is_archived": 0, - "is_starred": 0, - "language": "fr-FR", - "mimetype": "text/html", - "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg", - "reading_time": 2, - "tags": [], - "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama", - "updated_at": "2016-04-05T09:07:54+0000", - "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html", - "user_email": "", - "user_id": 1, - "user_name": "wallabag" - } - -Et si vous voulez voir la liste des articles existants (voir **Récupérer les articles existants**), le tableau sera vide. - -Exemple cURL : - -:: - - curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -Autres méthodes ---------------- - -Nous n'écrirons pas d'exemples pour toutes les méthodes de l'API. - -Jetez un œil à la liste complète ici http://localhost:8000/api/doc pour connaitre chaque méthode. - -Ressources tierces ------------------- - -Certaines applications ou bibliothèques utilisent notre API. En voici une liste non exhaustive : - -- `Java wrapper for the wallabag API `_ par Dmitriy Bogdanov. -- `.NET library for the wallabag v2 API `_ par Julian Oster. -- `Python API for wallabag `_ par FoxMaSk, pour son projet `Trigger Happy `_. -- `Un plugin `_ conçu pour `Tiny Tiny RSS `_ qui utilise l'API wallabag v2. Par Josh Panter. -- `Golang wrapper for the wallabag API `_ par Strubbl, pour son projets `wallabag-stats graphe `_ et l'outil de ligne de commande `wallabag-add-article `_. -- Tool to automatically download Wallabag articles into your local computer or Kobo ebook reader `wallabako `_ par anarcat. diff --git a/docs/fr/developer/asynchronous.rst b/docs/fr/developer/asynchronous.rst deleted file mode 100644 index ff22daea..00000000 --- a/docs/fr/developer/asynchronous.rst +++ /dev/null @@ -1,160 +0,0 @@ -Tâches asynchrones -================== - -Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ ou Redis. - -Installer RabbitMQ pour des tâches asynchrones ----------------------------------------------- - -Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser RabbitMQ. - -Pré-requis -^^^^^^^^^^ - -Vous devez installer RabbitMQ sur votre serveur. - -Installation -^^^^^^^^^^^^ - -.. code:: bash - - wget https://www.rabbitmq.com/rabbitmq-signing-key-public.asc - apt-key add rabbitmq-signing-key-public.asc - apt-get update - apt-get install rabbitmq-server - -Configuration et démarrage -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code:: bash - - rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest) - rabbitmq-server -detached - -Arrêter RabbitMQ -^^^^^^^^^^^^^^^^ - -.. code:: bash - - rabbitmqctl stop - -Configurer RabbitMQ dans wallabag -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration RabbitMQ. Celle par défaut devrait convenir : - -.. code:: yaml - - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - rabbitmq_prefetch_count: 10 # lire http://www.rabbitmq.com/consumer-prefetch.html - -Activer RabbitMQ dans wallabag -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1). - -Démarrer les clients RabbitMQ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job : - -.. code:: bash - - # for Pocket import - bin/console rabbitmq:consumer -e=prod import_pocket -w - - # for Readability import - bin/console rabbitmq:consumer -e=prod import_readability -w - - # for Instapaper import - bin/console rabbitmq:consumer -e=prod import_instapaper -w - - # for wallabag v1 import - bin/console rabbitmq:consumer -e=prod import_wallabag_v1 -w - - # for wallabag v2 import - bin/console rabbitmq:consumer -e=prod import_wallabag_v2 -w - - # for Firefox import - bin/console rabbitmq:consumer -e=prod import_firefox -w - - # for Chrome import - bin/console rabbitmq:consumer -e=prod import_chrome -w - -Installer Redis pour des tâches asynchrones -------------------------------------------- - -Pour lancer des tâches asynchrones (utile pour des imports importants par exemple), nous pouvons utiliser Redis. - -Pré-requis -^^^^^^^^^^ - -Vous devez installer Redis sur votre serveur. - -Installation -^^^^^^^^^^^^ - -.. code:: bash - - apt-get install redis-server - -Démarrage -^^^^^^^^^ - -Le serveur devrait déjà être démarré après l'installation. Si ce n'est pas le cas, vous pouvez le démarrer ainsi : - -.. code:: bash - - redis-server - -Configurer Redis dans wallabag -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Modifiez votre fichier ``app/config/parameters.yml`` pour éditer la configuration Redis. Celle par défaut devrait convenir : - -.. code:: yaml - - redis_host: localhost - redis_port: 6379 - -Activer Redis dans wallabag -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Dans les paramètres internes, section **Import**, activez Redis (avec la valeur 1). - -Démarrer les clients Redis -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -En fonction du service dont vous souhaitez importer vos données, vous devez activer un (ou plusieurs si vous souhaitez en supporter plusieurs) cron job : - -.. code:: bash - - # for Pocket import - bin/console wallabag:import:redis-worker -e=prod pocket -vv >> /path/to/wallabag/var/logs/redis-pocket.log - - # for Readability import - bin/console wallabag:import:redis-worker -e=prod readability -vv >> /path/to/wallabag/var/logs/redis-readability.log - - # for Instapaper import - bin/console wallabag:import:redis-worker -e=prod instapaper -vv >> /path/to/wallabag/var/logs/redis-instapaper.log - - # for wallabag v1 import - bin/console wallabag:import:redis-worker -e=prod wallabag_v1 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v1.log - - # for wallabag v2 import - bin/console wallabag:import:redis-worker -e=prod wallabag_v2 -vv >> /path/to/wallabag/var/logs/redis-wallabag_v2.log - - # for Firefox import - bin/console wallabag:import:redis-worker -e=prod firefox -vv >> /path/to/wallabag/var/logs/redis-firefox.log - - # for Chrome import - bin/console wallabag:import:redis-worker -e=prod chrome -vv >> /path/to/wallabag/var/logs/redis-chrome.log - -Si vous souhaitez démarrer l'import pour quelques messages uniquement, vous pouvez spécifier cette valeur en paramètre (ici 12) et le client va s'arrêter après le 12ème message : - -.. code:: bash - - bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 diff --git a/docs/fr/developer/console_commands.rst b/docs/fr/developer/console_commands.rst deleted file mode 100644 index 1b222b32..00000000 --- a/docs/fr/developer/console_commands.rst +++ /dev/null @@ -1,30 +0,0 @@ -Actions en ligne de commande -============================ - -wallabag 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. - -Chaque commande a une aide correspondante accessible via `bin/console help %command%`. - -.. note:: - - Si vous êtes dans un environnement de production, souvenez-vous d'ajouter `-e prod` à chaque commande. - -Commandes notables ------------------- - -* `assets:install`: Peut-être utile si les *assets* sont manquants. -* `cache:clear`: doit être exécuté après chaque mise à jour (appelé dans `make update`). -* `doctrine:migrations:status`: Montre le statut de vos migrations de vos bases de données. -* `fos:user:activate`: Activer manuellement un utilisateur. -* `fos:user:change-password`: Changer le mot de passe pour un utilisateur. -* `fos:user:create`: Créer un utilisateur. -* `fos:user:deactivate`: Désactiver un utilisateur (non supprimé). -* `fos:user:demote`: Supprimer un rôle d'un utilisateur, typiquement les droits d'administration. -* `fos:user:promote`: Ajoute un rôle à un utilisateur, typiquement les droits d'administration. -* `rabbitmq:*`: Peut-être utile si vous utilisez RabbitMQ. -* `wallabag:clean-duplicates`: Supprime tous les articles dupliqués pour un utilisateur ou bien tous. -* `wallabag:export`: Exporte tous les articles pour un utilisateur. Vous pouvez choisir le chemin du fichier exporté. -* `wallabag:import`: Importe les articles en différents formats dans un compte utilisateur. -* `wallabag:import:redis-worker`: Utile si vous utilisez Redis. -* `wallabag:install`: (ré)Installer wallabag -* `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/docker.rst b/docs/fr/developer/docker.rst deleted file mode 100644 index 84724ed3..00000000 --- a/docs/fr/developer/docker.rst +++ /dev/null @@ -1,50 +0,0 @@ -Exécuter wallabag avec docker-compose -===================================== - -Pour faire tourner votre propre instance de développement de wallabag, vous pouvez -utiliser les fichiers docker pré-configurés. - -Pré-requis ----------- - -Soyez sur d'avoir `Docker -`__ et `Docker -Compose `__ installés et à jour sur votre -système. - -Changer de SGBD ---------------- - -Par défaut, wallabag fonctionne avec une base de données SQLite. -Depuis que wallabag supporte Postgresql et MySQL, les conteneurs Docker sont -aussi disponibles pour ces SGBD. - -Dans ``docker-compose.yml``, en fonction de votre SGBD, décommentez : - -- la définition du conteneur (le block racine ``postgres`` ou ``mariadb``) -- le conteneur ``links`` dans le conteneur ``php`` -- le conteneur ``env_file`` dans le conteneur ``php`` - -Pour que les commandes Symfony (par exemple ``wallabag:install``) continuent de -fonctionner sur votre système, vous devez aussi : - -- charger le bon fichier d'environnement dans votre ligne de commandes (``source``), -pour que les variables comme ``SYMFONY__ENV__DATABASE_HOST`` existent. -- ajouter une ligne ``127.0.0.1 rdbms`` dans votre fichier ``hosts`` - -Exécuter wallabag ------------------ - -#. Forker et cloner le projet -#. Editer ``app/config/parameters.yml`` pour remplacer les propriétés ``database_*`` - par les lignes commentées (celles avec des valeurs préfixées par ``env.``) -#. ``composer install`` pour installer les dépendances -#. ``php bin/console wallabag:install`` pour créer le schéma de la BDD -#. ``docker-compose up`` pour démarrer les conteneurs -#. Enfin, se rendre sur http://localhost:8080/ pour accéder à une installation - tout propre de wallabag. - -Il est possible de rencontrer des problèmes de droits UNIX, de mauvais chemins -dans les fichiers de cache, etc… -Les opérations comme vider le cache ou restaurer les permissions des fichiers -peuvent être fréquemment nécessaires, n'ayez crainte ! diff --git a/docs/fr/developer/documentation.rst b/docs/fr/developer/documentation.rst deleted file mode 100644 index 0fbe5626..00000000 --- a/docs/fr/developer/documentation.rst +++ /dev/null @@ -1,12 +0,0 @@ -Contribuer à cette documentation -================================ - -Les sources de notre documentation sont ici https://github.com/wallabag/wallabag/tree/master/docs - -Nous utilisons `ReadTheDocs -`__ pour la générer. - -Les pages sont écrites au format `Restructured Text -`__. Vous pouvez utiliser des outils en ligne comme http://rst.aaroniles.net/ ou http://rst.ninjs.org/ pour prévisualiser vos articles. - -Si vous créez une nouvelle page, n'oubliez pas d'éditer le fichier `index.rst `__ pour ajouter un lien dans la barre latérale. \ No newline at end of file diff --git a/docs/fr/developer/front-end.rst b/docs/fr/developer/front-end.rst deleted file mode 100644 index 714df08b..00000000 --- a/docs/fr/developer/front-end.rst +++ /dev/null @@ -1,33 +0,0 @@ -Conseils pour développeurs front-end -==================================== - -Depuis la version 2.3, wallabag utilise webpack pour générer ses assets. - -Mode développeur ----------------- - -Si 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,...). - -Live reload ------------ - -Webpack 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. - -.. note:: - - N'oubliez pas de remettre ``use_webpack_dev_server`` à ``false`` lorsque vous n'utilisez pas la fonctionnalité de live reload. - -Production builds ------------------ - -Lorsque 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``. - -.. note:: - - N'oubliez pas de générer des fichiers en mode production avant de committer ! - - -Code style ----------- - -Le 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/developer/paywall.rst b/docs/fr/developer/paywall.rst deleted file mode 100644 index ddba839a..00000000 --- a/docs/fr/developer/paywall.rst +++ /dev/null @@ -1,65 +0,0 @@ -Articles derrière un paywall -============================ - -wallabag peut récupérer le contenu des articles des sites qui utilisent un système de paiement. - -Activer l'authentification pour les paywall -------------------------------------------- - -Dans les paramètres internes, en tant qu'administrateur de wallabag, section **Article**, activez l'authentification pour les articles derrière un paywall (avec la valeur 1). - -Configurer les accès dans wallabag ----------------------------------- - -Éditez le fichier ``app/config/parameters.yml`` pour modifier les accès aux sites avec paywall. Par exemple, sous Ubuntu : - -``sudo -u www-data nano /var/www/html/wallabag/app/config/parameters.yml`` - -Voici un exemple pour certains sites (attention, ne pas utiliser la touche "tab", seulement des espaces) : - -.. code:: yaml - - sites_credentials: - mediapart.fr: {username: "myMediapartLogin", password: "mypassword"} - arretsurimages.net: {username: "myASILogin", password: "mypassword"} - -.. note:: - - Ces accès seront partagés entre chaque utilisateur de votre instance wallabag. - -Fichiers de configuration pour parser les articles --------------------------------------------------- - -.. note:: - - Lisez `cette documentation `_ pour en savoir plus sur ces fichiers de configuration, qui se trouvent dans le répertoire ``vendor/j0k3r/graby-site-config/``. Pour la majorité des sites, ce fichier est déjà configuré : les instructions qui suivent concernent seulement les sites non encore configurés. - -Chaque fichier de configuration doit être enrichi en ajoutant ``requires_login``, ``login_uri``, -``login_username_field``, ``login_password_field`` et ``not_logged_in_xpath``. - -Attention, le formulaire de connexion doit se trouver dans le contenu de la page lors du chargement de celle-ci. -Il sera impossible pour wallabag de se connecter à un site dont le formulaire de connexion est chargé après coup (en ajax par exemple). - -``login_uri`` correspond à l'URL à laquelle le formulaire est soumis (attribut ``action`` du formulaire). -``login_username_field`` correspond à l'attribut ``name`` du champ de l'identifiant. -``login_password_field`` correspond à l'attribut ``name`` du champ du mot de passe. - -Par exemple : - -.. code:: - - title://div[@id="titrage-contenu"]/h1[@class="title"] - body: //div[@class="contenu-html"]/div[@class="page-pane"] - - requires_login: yes - - login_uri: http://www.arretsurimages.net/forum/login.php - login_username_field: username - login_password_field: password - - not_logged_in_xpath: //body[@class="not-logged-in"] - -Dernière étape : nettoyer le cache ----------------------------------- - -Il est nécessaire de nettoyer le cache de wallabag avec la commande suivante (ici sous Ubuntu) : ``sudo -u www-data php /var/www/html/wallabag/bin/console cache:clear -e=prod`` diff --git a/docs/fr/developer/testsuite.rst b/docs/fr/developer/testsuite.rst deleted file mode 100644 index bd5c68c6..00000000 --- a/docs/fr/developer/testsuite.rst +++ /dev/null @@ -1,10 +0,0 @@ -Suite de tests -============== - -Pour assurer la qualité du développement de wallabag, nous avons écrit des tests avec `PHPUnit `_. - -Si vous contribuez au projet (en traduisant l'application, en corrigeant des bugs ou en ajoutant une nouvelle fonctionnalité), merci d'écrire vos propres tests. - -Pour lancer la suite de tests de wallabag, vous devez installer `ant `_. - -Ensuite, exécutez la commande ``make test``. diff --git a/docs/fr/developer/translate.rst b/docs/fr/developer/translate.rst deleted file mode 100644 index 870d1c20..00000000 --- a/docs/fr/developer/translate.rst +++ /dev/null @@ -1,62 +0,0 @@ -Traduire wallabag -================= - -L'application web ------------------ - -Fichiers de traductions -~~~~~~~~~~~~~~~~~~~~~~~ - -.. note:: - - Comme wallabag est principalement dévelopée par une équipe française, c'est - cette traduction qui est considérée comme la plus récente. Merci de vous baser - sur celle-ci pour créer votre traduction. - -Les principaux fichiers de traduction se trouvent ici : https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations. - -Vous devez créer les fichiers ``messages.CODE.yml`` et ``validators.CODE.yml``, -où CODE est le code ISO 639-1 de votre langue (`cf wikipedia `__). - -Autres fichiers à traduire : - -- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. -- https://github.com/wallabag/wallabag/tree/master/src/Wallabag/UserBundle/Resources/translations. - -Vous devez créer les fichiers ``LE_FICHIER_DE_TRADUCTION.CODE.yml``. - -Fichier de configuration -~~~~~~~~~~~~~~~~~~~~~~~~ - -Vous devez éditer `app/config/config.yml -`__ pour -afficher votre langue dans la page Configuration de wallabag (pour permettre aux -utilisateurs de choisir cette nouvelle traduction). - -Dans la section ``wallabag_core.languages``, vous devez ajouter une nouvelle ligne -avec votre traduction. Par exemple : - -:: - - wallabag_core: - ... - languages: - en: 'English' - fr: 'Français' - - -Pour la première colonne (``en``, ``fr``, etc.), vous devez ajouter le code ISO 639-1 -de votre langue (voir ci-dessus). - -Pour la seconde colonne, c'est juste le nom de votre langue. - -Documentation de wallabag -------------------------- - -.. note:: - - Contrairement à l'application, la langue principale de la documentation est l'anglais - -Les fichiers de documentation se trouvent ici : https://github.com/wallabag/wallabag/tree/master/docs - -Vous devez respecter la structure du dossier ``en`` quand vous crééz votre traduction. -- cgit v1.2.3