Add documentation about article sharing

diff --git a/README.md b/README.md
index 2ce6479ef5d833787757366409330336738f74f1..73c34ae0eb407f8e97efb190ea76bfad963106ec 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,15 +10,14 @@ More informations on our website: [wallabag.org](https://wallabag.org)
 
 # Install wallabag
 
-If you don't have it yet, please [install composer](https://getcomposer.org/download/) or be sure to use Composer 1.2 (`composer selfupdate` can help you about that).
+If you don't have it yet, please [install composer](https://getcomposer.org/download/) or be sure to use Composer 1.2 (`composer selfupdate` can help you about that). Read [our documentation](http://doc.wallabag.org) to have more information about installation. 
 Then you can install wallabag by executing the following commands:
 
 ```
     git clone https://github.com/wallabag/wallabag.git
     cd wallabag
-    git checkout 2.0.8
-    SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
-    php bin/console wallabag:install --env=prod
+    git checkout 2.1
+    ./install.sh
     php bin/console server:run --env=prod
 ```
 

diff --git a/app/config/config.yml b/app/config/config.yml
index b3d713044259d2929ebcad42a7ea024251bb72af..43e553e3dd738ff9eb2a82a0bfe1650ce5523cbb 100644 (file)
--- a/app/config/config.yml
+++ b/app/config/config.yml
@@ -30,7 +30,7 @@ framework:
     assets: ~
 
 wallabag_core:
-    version: 2.0.8
+    version: 2.1
     paypal_url: "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9UBA65LG3FX9Y&lc=gb"
     languages:
         en: 'English'

diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst
index fced2ed4a6a8047ce228bb2028e2d3eccd5a8b38..2e3108beb38fa8446806c7626062d93dd09d15e2 100644 (file)
--- a/docs/de/user/installation.rst
+++ b/docs/de/user/installation.rst
@@ -46,7 +46,7 @@ Composer installieren:
 
     curl -s http://getcomposer.org/installer | php
 
-Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden:
+Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden.
 
 Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen:
 

diff --git a/docs/en/index.rst b/docs/en/index.rst
index bc3ce4c2bd251fcfd0cf6f619eb5e90fd44340d7..46450b8f0fd5cf0455828679df875c07e57af8f6 100644 (file)
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -40,6 +40,7 @@ The documentation is available in other languages:
    user/errors_during_fetching
    user/annotations
    user/download_articles
+   user/share
    user/filters
    user/tags
    user/android

diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 763d7c66d2acb4719adbaaec15b43950fd1baaa8..3794c75763cf8e8a5e8fd06301a7fe6453255d1a 100644 (file)
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -37,7 +37,7 @@ Installation
 On a dedicated web server (recommended way)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-wallabag uses a large number of 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``).
+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``).
 
 Install Composer:
 
@@ -45,7 +45,14 @@ Install Composer:
 
     curl -s http://getcomposer.org/installer | php
 
-You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__:
+You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
+
+You also need to install node.js (via `the Download page <https://nodejs.org/en/download/>`__), npm (already install with node.js), bower and grunt:
+
+::
+
+    npm install -g bower
+    npm install -g grunt-cli
 
 To install wallabag itself, you must run the following commands:
 
@@ -53,9 +60,8 @@ To install wallabag itself, you must run the following commands:
 
     git clone https://github.com/wallabag/wallabag.git
     cd wallabag
-    git checkout 2.0.8
-    SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
-    php bin/console wallabag:install --env=prod
+    git checkout 2.1
+    ./install.sh
 
 To start PHP's build-in server and test if everything did install correctly, you can do:
 

diff --git a/docs/en/user/share.rst b/docs/en/user/share.rst
new file mode 100644 (file)
index 0000000..e99e51a
--- /dev/null
+++ b/docs/en/user/share.rst
@@ -0,0 +1,17 @@
+Share articles
+==============
+
+When you're reading an article, you can share it. Just click on the share button:
+
+.. image:: ../../img/user/share.png
+   :alt: share article
+   :align: center
+
+Now, you can share the article:
+
+- with a public URL (you'll have a light view of the article)
+- with a tweet
+- into your Shaarli
+- with a post in Diaspora*
+- to Carrot
+- with an email

diff --git a/docs/fr/index.rst b/docs/fr/index.rst
index 095f1a69f061075c8d1a763d979e70a545afa3dc..dfa55afe676049c629c26545d94d29e7c4032a05 100644 (file)
--- a/docs/fr/index.rst
+++ b/docs/fr/index.rst
@@ -41,6 +41,7 @@ La documentation est disponible dans d'autres langues :
    user/errors_during_fetching
    user/annotations
    user/download_articles
+   user/share
    user/filters
    user/tags
 

diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index 480970c53fea3f0d0878c6101a42b6196f3e794e..105e8122137a22ecf164e78b18754a4835a26f29 100644 (file)
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -35,7 +35,7 @@ Installation
 Sur un serveur dédié (méthode conseillée)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-wallabag utilise un grand nombre de bibliothèques pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``).
+wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``).
 
 Installation de Composer :
 
@@ -43,17 +43,23 @@ Installation de Composer :
 
     curl -s http://getcomposer.org/installer | php
 
-Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__ :
+Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
 
-Pour installer wallabag, vous devez exécuter ces deux commandes :
+Vous devez aussi installer node.js (via `la page de téléchargements <https://nodejs.org/en/download/>`__), npm (déjà installé avec node.js), bower et grunt:
+
+::
+
+    npm install -g bower
+    npm install -g grunt-cli
+
+Pour installer wallabag, vous devez exécuter ces commandes :
 
 ::
 
     git clone https://github.com/wallabag/wallabag.git
     cd wallabag
-    git checkout 2.0.8
-    SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
-    php bin/console wallabag:install --env=prod
+    git checkout 2.1
+    ./install.sh
 
 Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
 

diff --git a/docs/fr/user/share.rst b/docs/fr/user/share.rst
new file mode 100644 (file)
index 0000000..b5faa5b
--- /dev/null
+++ b/docs/fr/user/share.rst
@@ -0,0 +1,17 @@
+Partager des articles
+=====================
+
+Quand vous lisez un article, vous pouvez le partager. Cliquez sur le bouton de partage :
+
+.. image:: ../../img/user/share.png
+   :alt: partager un article
+   :align: center
+
+Vous pouvez maintenant le partager :
+
+- avec une URL publique (vous obtiendrez une vue allégée de l'article)
+- avec un tweet
+- dans votre Shaarli
+- avec un message dans Diaspora*
+- sur Carrot
+- avec un email

diff --git a/docs/img/user/share.png b/docs/img/user/share.png
new file mode 100644 (file)
index 0000000..4cfe9ed
Binary files /dev/null and b/docs/img/user/share.png differ