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/en/developer/api.rst | 271 --------------------------------- docs/en/developer/asynchronous.rst | 160 ------------------- docs/en/developer/console_commands.rst | 30 ---- docs/en/developer/docker.rst | 51 ------- docs/en/developer/documentation.rst | 12 -- docs/en/developer/front_end.rst | 33 ---- docs/en/developer/paywall.rst | 65 -------- docs/en/developer/testsuite.rst | 10 -- docs/en/developer/translate.rst | 60 -------- 9 files changed, 692 deletions(-) delete mode 100644 docs/en/developer/api.rst delete mode 100644 docs/en/developer/asynchronous.rst delete mode 100644 docs/en/developer/console_commands.rst delete mode 100644 docs/en/developer/docker.rst delete mode 100644 docs/en/developer/documentation.rst delete mode 100644 docs/en/developer/front_end.rst delete mode 100644 docs/en/developer/paywall.rst delete mode 100644 docs/en/developer/testsuite.rst delete mode 100644 docs/en/developer/translate.rst (limited to 'docs/en/developer') diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst deleted file mode 100644 index 80c96025..00000000 --- a/docs/en/developer/api.rst +++ /dev/null @@ -1,271 +0,0 @@ -API documentation -================= - -Thanks to this documentation, we'll see how to interact with the wallabag API. - -Requirements ------------- - -* wallabag freshly (or not) installed on http://localhost:8000 -* ``httpie`` installed on your computer (`see project website `__). Note that you can also adapt the commands using curl or wget. -* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance `_ - -Creating a new API client -------------------------- - -In your wallabag account, you can create a new API client at this URL http://localhost:8000/developer/client/create. - -Just give the redirect URL of your application and create your client. If your application is a desktop one, put whatever URL suits you the most. - -You get information like this: - -:: - - Client ID: - - 1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc - - Client secret: - - 636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 - - -Obtaining a refresh token -------------------------- - -For each API call, you'll need a token. Let's create it with this command (replace ``client_id``, ``client_secret``, ``username`` and ``password`` with their values): - -:: - - http POST http://localhost:8000/oauth/v2/token \ - grant_type=password \ - client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \ - client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \ - username=wallabag \ - password=wallabag - -You'll have this in return: - -:: - - 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" - } - -We'll work with the ``access_token`` value in our next calls. - -cURL example: - -:: - - curl -s "https://localhost:8000/oauth/v2/token?grant_type=password&client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc&client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4&username=wallabag&password=wallabag" - -Getting existing entries ------------------------- - -Documentation for this method: http://localhost:8000/api/doc#get--api-entries.{_format} - -As we work on a fresh wallabag installation, we'll have no result with this command: - -:: - - http GET http://localhost:8000/api/entries.json \ - "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -returns: - -:: - - 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 - } - -The ``items`` array is empty. - -cURL example: - -:: - - curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -Adding your first entry ------------------------ - -Documentation for this method: 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" - -returns - -:: - - 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" - } - -Now, if you execute the previous command (see **Get existing entries**), you'll have data. - -cURL example: - -:: - - 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" - -Deleting an entry ------------------ - -Documentation for this method: http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format} - -:: - - http DELETE http://localhost:8000/api/entries/1.json \ - "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -returns - -:: - - 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" - } - -And if you want to list the existing entries (see **Get existing entries**), the array is empty. - -cURL example: - -:: - - curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" - -Other methods -------------- - -We won't write samples for each API method. - -Have a look on the listing here: http://localhost:8000/api/doc to know each method. - -Third party resources ---------------- - -Some applications or libraries use our API. Here is a non-exhaustive list of them: - -- `Java wrapper for the wallabag API `_ by Dmitriy Bogdanov. -- `.NET library for the wallabag v2 API `_ by Julian Oster. -- `Python API for wallabag `_ by FoxMaSk, for his project `Trigger Happy `_. -- `A plugin `_ designed for `Tiny Tiny RSS `_ that makes use of the wallabag v2 API. By Josh Panter. -- `Golang wrapper for the wallabag API `_ by Strubbl, for his projects `wallabag-stats graph `_ and the command line tool `wallabag-add-article `_. -- Tool to automatically download Wallabag articles into your local computer or Kobo ebook reader `wallabako `_ by anarcat. diff --git a/docs/en/developer/asynchronous.rst b/docs/en/developer/asynchronous.rst deleted file mode 100644 index 2e409e4a..00000000 --- a/docs/en/developer/asynchronous.rst +++ /dev/null @@ -1,160 +0,0 @@ -Asynchronous tasks -================== - -In order to launch asynchronous tasks (useful for huge imports for example), we can use RabbitMQ or Redis. - -Install RabbitMQ for asynchronous tasks ---------------------------------------- - -Requirements -^^^^^^^^^^^^ - -You need to have RabbitMQ installed on your server. - -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 and launch -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. code:: bash - - rabbitmq-plugins enable rabbitmq_management # (useful to have a web interface, available at http://localhost:15672/ (guest/guest) - rabbitmq-server -detached - -Stop RabbitMQ -^^^^^^^^^^^^^ - -.. code:: bash - - rabbitmqctl stop - - -Configure RabbitMQ in wallabag -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Edit your ``app/config/parameters.yml`` file to edit RabbitMQ configuration. The default one should be ok: - -.. code:: yaml - - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - rabbitmq_prefetch_count: 10 # read http://www.rabbitmq.com/consumer-prefetch.html - -Enable RabbitMQ in wallabag -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -In internal settings, in the **Import** section, enable RabbitMQ (with the value 1). - -Launch RabbitMQ consumer -^^^^^^^^^^^^^^^^^^^^^^^^ - -Depending on which service you want to import from you need to enable one (or many if you want to support many) 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 - -Install Redis for asynchronous tasks ------------------------------------- - -In order to launch asynchronous tasks (useful for huge imports for example), we can use Redis. - -Requirements -^^^^^^^^^^^^ - -You need to have Redis installed on your server. - -Installation -^^^^^^^^^^^^ - -.. code:: bash - - apt-get install redis-server - -Launch -^^^^^^ - -The server might be already running after installing, if not you can launch it using: - -.. code:: bash - - redis-server - - -Configure Redis in wallabag -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Edit your ``app/config/parameters.yml`` file to edit Redis configuration. The default one should be ok: - -.. code:: yaml - - redis_host: localhost - redis_port: 6379 - -Enable Redis in wallabag -^^^^^^^^^^^^^^^^^^^^^^^^ - -In internal settings, in the **Import** section, enable Redis (with the value 1). - -Launch Redis consumer -^^^^^^^^^^^^^^^^^^^^^ - -Depending on which service you want to import from you need to enable one (or many if you want to support many) 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 - -If you want to launch the import only for some messages and not all, you can specify this number (here 12) and the worker will stop right after the 12th message : - -.. code:: bash - - bin/console wallabag:import:redis-worker -e=prod pocket -vv --maxIterations=12 diff --git a/docs/en/developer/console_commands.rst b/docs/en/developer/console_commands.rst deleted file mode 100644 index 85a8a092..00000000 --- a/docs/en/developer/console_commands.rst +++ /dev/null @@ -1,30 +0,0 @@ -Console Commands -================ - -wallabag 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. - -Each command has a help accessible through `bin/console help %command%`. - -.. note:: - - If you're in a production environment, remember to add `-e prod` to each command. - -Notable commands ----------------- - -* `assets:install`: May be helpful if assets are missing. -* `cache:clear`: should be run after each update (included in `make update`). -* `doctrine:migrations:status`: Output the status of your database migrations. -* `fos:user:activate`: Manually activate an user. -* `fos:user:change-password`: Change a password for an user. -* `fos:user:create`: Create an user. -* `fos:user:deactivate`: Deactivate an user (not deleted). -* `fos:user:demote`: Removes a role from an user, typically admin rights. -* `fos:user:promote`: Adds a role to an user, typically admin rights. -* `rabbitmq:*`: May be useful if you're using RabbitMQ. -* `wallabag:clean-duplicates`: Removes all entry duplicates for one user or all users -* `wallabag:export`: Exports all entries for an user. You can choose the output path of the file. -* `wallabag:import`: Import entries to different formats to an user account. -* `wallabag:import:redis-worker`: Useful if you use Redis. -* `wallabag:install`: (re)Install wallabag -* `wallabag:tag:all`: Tag all entries for an user using his/her tagging rules. diff --git a/docs/en/developer/docker.rst b/docs/en/developer/docker.rst deleted file mode 100644 index 5e4f2ce6..00000000 --- a/docs/en/developer/docker.rst +++ /dev/null @@ -1,51 +0,0 @@ -Run wallabag in docker-compose -============================== - -In order to run your own development instance of wallabag, you may -want to use the pre-configured docker compose files. - -Requirements ------------- - -Make sure to have `Docker -`__ and `Docker -Compose `__ availables on -your system and up to date. - -Switch DBMS ------------ - -By default, wallabag will start with a SQLite database. -Since wallabag provides support for Postgresql and MySQL, docker -containers are also available for these ones. - -In ``docker-compose.yml``, for the chosen DBMS uncomment: - -- the container definition (``postgres`` or ``mariadb`` root level - block) -- the container link in the ``php`` container -- the container env file in the ``php`` container - -In order to keep running Symfony commands on your host (such as -``wallabag:install``), you also should: - -- source the proper env files on your command line, so variables - like ``SYMFONY__ENV__DATABASE_HOST`` will exist. -- create a ``127.0.0.1 rdbms`` on your system ``hosts`` file - -Run wallabag ------------- - -#. Fork and clone the project -#. Edit ``app/config/parameters.yml`` to replace ``database_*`` - properties with commented ones (with values prefixed by ``env.``) -#. ``composer install`` the project dependencies -#. ``php bin/console wallabag:install`` to create the schema -#. ``docker-compose up`` to run the containers -#. Finally, browse to http://localhost:8080/ to find your freshly - installed wallabag. - -At various step, you'll probably run into UNIX permission problems, -bad paths in generated cache, etc… -Operations like removing cache files or changing files owners might -be frequently required, so don't be afraid ! diff --git a/docs/en/developer/documentation.rst b/docs/en/developer/documentation.rst deleted file mode 100644 index ab206479..00000000 --- a/docs/en/developer/documentation.rst +++ /dev/null @@ -1,12 +0,0 @@ -Contribute to this documentation -================================ - -Sources of our documentation are here https://github.com/wallabag/wallabag/tree/master/docs - -We use `ReadTheDocs -`__ to generate it. - -Pages are written in `Restructured Text -`__ format. You can use online tools like http://rst.aaroniles.net/ or http://rst.ninjs.org/ to preview your articles. - -If you create a new page, don't forget to edit the `index.rst `__ file to add a link in the sidebar. \ No newline at end of file diff --git a/docs/en/developer/front_end.rst b/docs/en/developer/front_end.rst deleted file mode 100644 index 40f18a42..00000000 --- a/docs/en/developer/front_end.rst +++ /dev/null @@ -1,33 +0,0 @@ -Tips for front-end developers -============================= - -Starting from version 2.3, wallabag uses webpack to bundle its assets. - -Dev mode --------- - -If 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,...). - -Live reload ------------ - -Webpack 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. - -.. note:: - - Don't forget to put back ``use_webpack_dev_server`` to ``false`` when not using the live reload feature. - -Production builds ------------------ - -When 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``. - -.. note:: - - Don't forget to generate production builds before committing ! - - -Code style ----------- - -Code 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/developer/paywall.rst b/docs/en/developer/paywall.rst deleted file mode 100644 index 153afa6f..00000000 --- a/docs/en/developer/paywall.rst +++ /dev/null @@ -1,65 +0,0 @@ -Articles behind a paywall -========================= - -wallabag can fetch articles from websites which use a paywall system. - -Enable paywall authentication ------------------------------ - -In internal settings, as a wallabag administrator, in the **Article** section, enable authentication for websites with paywall (with the value 1). - -Configure credentials in wallabag ---------------------------------- - -Edit your ``app/config/parameters.yml`` file to edit credentials for each website with paywall. For example, under Ubuntu: - -``sudo -u www-data nano /var/www/html/wallabag/app/config/parameters.yml`` - -Here is an example for some french websites (be careful: don't use the "tab" key, only spaces): - -.. code:: yaml - - sites_credentials: - mediapart.fr: {username: "myMediapartLogin", password: "mypassword"} - arretsurimages.net: {username: "myASILogin", password: "mypassword"} - -.. note:: - - These credentials will be shared between each user of your wallabag instance. - -Parsing configuration files ---------------------------- - -.. note:: - - Read `this part of the documentation `_ to understand the configuration files, which are located under ``vendor/j0k3r/graby-site-config/``. For most of the websites, this file is already configured: the following instructions are only for the websites that are not configured yet. - -Each parsing configuration file needs to be improved by adding ``requires_login``, ``login_uri``, -``login_username_field``, ``login_password_field`` and ``not_logged_in_xpath``. - -Be careful, the login form must be in the page content when wallabag loads it. It's impossible for wallabag to be authenticated -on a website where the login form is loaded after the page (by ajax for example). - -``login_uri`` is the action URL of the form (``action`` attribute in the form). -``login_username_field`` is the ``name`` attribute of the login field. -``login_password_field`` is the ``name`` attribute of the password field. - -For example: - -.. 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"] - -Last step: clear the cache --------------------------- - -It's necessary to clear the wallabag cache with the following command (here under Ubuntu): ``sudo -u www-data php /var/www/html/wallabag/bin/console cache:clear -e=prod`` diff --git a/docs/en/developer/testsuite.rst b/docs/en/developer/testsuite.rst deleted file mode 100644 index b2b16cdc..00000000 --- a/docs/en/developer/testsuite.rst +++ /dev/null @@ -1,10 +0,0 @@ -Testsuite -========= - -To ensure wallabag development quality, we wrote tests with `PHPUnit `_. - -If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests. - -To launch wallabag testsuite, you need to install `ant `_. - -Then, execute this command ``make test``. diff --git a/docs/en/developer/translate.rst b/docs/en/developer/translate.rst deleted file mode 100644 index 1e5d5009..00000000 --- a/docs/en/developer/translate.rst +++ /dev/null @@ -1,60 +0,0 @@ -Translate wallabag -================== - -wallabag web application ------------------------- - -Translation files -~~~~~~~~~~~~~~~~~ - -.. note:: - - As wallabag is mainly developed by a French team, please consider that french - translation is the most updated one and please copy it to create your own translation. - -You can find translation files here: https://github.com/wallabag/wallabag/tree/master/src/Wallabag/CoreBundle/Resources/translations. - -You have to create ``messages.CODE.yml`` and ``validators.CODE.yml``, where CODE -is the ISO 639-1 code of your language (`see wikipedia `__). - -Other files to translate: - -- https://github.com/wallabag/wallabag/tree/master/app/Resources/CraueConfigBundle/translations. -- https://github.com/wallabag/wallabag/tree/master/src/Wallabag/UserBundle/Resources/translations. - -You have to create ``THE_TRANSLATION_FILE.CODE.yml`` files. - -Configuration file -~~~~~~~~~~~~~~~~~~ - -You have to edit `app/config/config.yml -`__ to display -your language on Configuration page of wallabag (to allow users to switch to this new translation). - -Under the ``wallabag_core.languages`` section, you have to add a new line with -your translation. For example: - -:: - - wallabag_core: - ... - languages: - en: 'English' - fr: 'Français' - - -For the first column (``en``, ``fr``, etc.), you have to add the ISO 639-1 code -of your language (see above). - -For the second column, it's the name of your language. Just that. - -wallabag documentation ----------------------- - -.. note:: - - Contrary to the web application, the main language for documentation is english. - -Documentation files are stored here: https://github.com/wallabag/wallabag/tree/master/docs - -You need to respect the ``en`` folder structure when you create your own translation. -- cgit v1.2.3