Merge remote-tracking branch 'origin/master' into 2.2

docs/en/developer/api.rst

@@ -8,7 +8,7 @@ Requirements
 
 * wallabag freshly (or not) installed on http://localhost:8000
 * ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget.
-* all the API methods are documented here http://localhost:8000/api/doc
+* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance <http://v2.wallabag.org/api/doc>`_ 
 
 Creating a new API client
 -------------------------

docs/en/developer/redis.rst

@@ -35,7 +35,7 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s
     redis_host: localhost
     redis_port: 6379
 
-Enable Redos in wallabag
+Enable Redis in wallabag
 ------------------------
 
 In internal settings, in the **Import** section, enable Redis (with the value 1).

docs/en/index.rst

@@ -45,6 +45,8 @@ The documentation is available in other languages:
    user/filters
    user/tags
    user/android
+   user/parameters
+   user/backup
 
 .. _dev-docs:
 

docs/en/user/android.rst

@@ -79,7 +79,7 @@ Known limitations
 2FA
 ~~~
 
-Currently the does not support two-factor authentication. You should disable that to get the app working.
+Currently the Android application does not support two-factor authentication. You should disable that to get the application working.
 
 
 Limited amount of articles with wallabag v2

docs/en/user/backup.rst

@@ -0,0 +1,25 @@
+Backup wallabag
+===============
+Because sometimes you may do a mistake with your wallabag and lose data or in case you need to move your wallabag to another server you want to backup your data.
+This articles describes what you need to backup.
+
+Basic settings
+--------------
+wallabag stores some basic parameters (like SMTP server or database backend) in the file `app/config/parameters.yml`.
+
+Database
+--------
+As wallabag supports different kinds of database, the way to perform the backup depends on the database you use, so you need to refer to the vendor documentation.
+
+Here's some examples:
+
+- MySQL: http://dev.mysql.com/doc/refman/5.7/en/backup-methods.html
+- PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html
+
+SQLite
+~~~~~~
+To backup the SQLite database, you just need to copy the directory `data/db` from the wallabag application directory.
+
+Images
+------
+The images retrieved by wallabag are stored under `data/assets/images` (the images storage will be implemented in wallabag 2.2).

docs/en/user/configuration.rst

@@ -102,7 +102,7 @@ if *« readingTime >= 5 AND domainName = "github.com" »* then tag as *« long r
 Which variables and operators can I use to write rules?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The following variables and operators can be used to create tagging rules:
+The following variables and operators can be used to create tagging rules (be careful, for some values, you need to add quotes, for example ``language = "en"``):
 
 ===========  ==============================================  ========  ==========
 Variable     Meaning                                         Operator  Meaning

docs/en/user/installation.rst

@@ -8,7 +8,7 @@ wallabag is compatible with PHP >= 5.5, including PHP 7.
 
 .. note::
 
-    To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool.
+    To install wallabag easily, we provide a ``Makefile``, so you need to have the ``make`` tool.
 
 wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``).
 
@@ -95,7 +95,7 @@ If you changed the database configuration to use MySQL or PostgreSQL, you need t
 Installation with Docker
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information.
+We provide you a Docker image to install wallabag easily. Have a look at our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ for more information.
 
 Command to launch container
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -194,12 +194,12 @@ After reloading or restarting nginx, you should now be able to access wallabag a
 
 .. tip::
 
-    When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``.
+    When you want to import large files into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``.
 
 Configuration on lighttpd
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it):
+Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it):
 
 ::
 
@@ -249,7 +249,7 @@ As soon as we use Apache or Nginx to access to our wallabag instance, and not fr
 
 To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used).
 
-So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this could be not enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project.
+So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this may not be enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project.
 
 This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command:
 

docs/en/user/parameters.rst

@@ -9,7 +9,7 @@ What is the meaning of the parameters?
    "database_name", "symfony", "name of your database"
    "database_user", "root", "user that can write to this database"
    "database_password", "~", "password of that user"
-   "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it for other database"
+   "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it empty for other database"
    "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity"
    "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored)"
    "database_charset", "utf8mb4", "For PostgreSQL & SQLite you should use utf8, for MySQL use utf8mb4 which handle emoji"
@@ -39,7 +39,7 @@ What is the meaning of the parameters?
 
    "rabbitmq_host", "localhost", "Host of your RabbitMQ"
    "rabbitmq_port", "5672", "Port of your RabbitMQ"
-   "rabbitmq_user", "guest", "Usee that can read queues"
+   "rabbitmq_user", "guest", "User that can read queues"
    "rabbitmq_password", "guest", "Password of that user"
 
 .. csv-table:: Redis configuration

docs/en/user/upgrade-2.0.x-2.1.1.rst

@@ -2,7 +2,8 @@ Upgrade from 2.0.x to 2.1.1
 ===========================
 
 .. warning::
-Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade.
+
+    Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade.
 
 Upgrade on a dedicated web server
 ---------------------------------
@@ -64,6 +65,8 @@ Please check that your ``app/config/parameters.yml`` contains all the required p
         redis_host: localhost
         redis_port: 6379
 
+You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
+
 If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
 
 Empty ``var/cache`` folder.

docs/en/user/upgrade-2.1.x-2.1.y.rst

@@ -26,7 +26,7 @@ Download the last release of wallabag:
 
     wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
 
-(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
+You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
 
 Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.