From 8fed8d1bacbbcbf606a94497c5b58f49068bd6a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 25 Aug 2016 15:28:46 +0200 Subject: Add documentation about article sharing --- README.md | 7 +++---- app/config/config.yml | 2 +- docs/de/user/installation.rst | 2 +- docs/en/index.rst | 1 + docs/en/user/installation.rst | 16 +++++++++++----- docs/en/user/share.rst | 17 +++++++++++++++++ docs/fr/index.rst | 1 + docs/fr/user/installation.rst | 18 ++++++++++++------ docs/fr/user/share.rst | 17 +++++++++++++++++ docs/img/user/share.png | Bin 0 -> 9435 bytes 10 files changed, 64 insertions(+), 17 deletions(-) create mode 100644 docs/en/user/share.rst create mode 100644 docs/fr/user/share.rst create mode 100644 docs/img/user/share.png diff --git a/README.md b/README.md index 2ce6479e..73c34ae0 100644 --- 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 b3d71304..43e553e3 100644 --- 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 fced2ed4..2e3108be 100644 --- 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 `__ finden: +Du kannst eine spezifische Anleitung `hier `__ 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 bc3ce4c2..46450b8f 100644 --- 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 763d7c66..3794c757 100644 --- 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 `__: +You can find specific instructions `here `__. + +You also need to install node.js (via `the Download page `__), 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 index 00000000..e99e51ab --- /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 095f1a69..dfa55afe 100644 --- 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 480970c5..105e8122 100644 --- 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) `__ : +Vous pouvez trouver des instructions spécifiques `ici (en anglais) `__. -Pour installer wallabag, vous devez exécuter ces deux commandes : +Vous devez aussi installer node.js (via `la page de téléchargements `__), 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 index 00000000..b5faa5ba --- /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 index 00000000..4cfe9edb Binary files /dev/null and b/docs/img/user/share.png differ -- cgit v1.2.3 From ce0a32229a8d139115ccd1d247a0ee4f1fedc8a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 15 Sep 2016 14:26:30 +0200 Subject: Fix wallabag version in documentation --- docs/de/user/installation.rst | 5 ++--- docs/de/user/upgrade.rst | 7 +++---- docs/en/user/installation.rst | 9 +-------- docs/en/user/upgrade.rst | 7 +++---- docs/fr/user/installation.rst | 9 +-------- docs/fr/user/upgrade.rst | 7 +++---- 6 files changed, 13 insertions(+), 31 deletions(-) diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index 2e3108be..05602bf3 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -54,9 +54,8 @@ Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: 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.0 + ./install.sh Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: diff --git a/docs/de/user/upgrade.rst b/docs/de/user/upgrade.rst index c04b68f3..953c84ff 100644 --- a/docs/de/user/upgrade.rst +++ b/docs/de/user/upgrade.rst @@ -4,15 +4,14 @@ Wallabag updaten Update auf einem dedizierten Webserver -------------------------------------- -Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.8`` mit der neuesten Releasenummer): +Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.0`` mit der neuesten Releasenummer): :: git fetch origin git fetch --tags - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console cache:clear --env=prod + git checkout 2.1.0 + ./install.sh Update auf einem Shared Webhosting ---------------------------------- diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 3794c757..8e9f71d4 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -47,20 +47,13 @@ Install Composer: You can find specific instructions `here `__. -You also need to install node.js (via `the Download page `__), 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: :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1 + git checkout 2.1.0 ./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/upgrade.rst b/docs/en/user/upgrade.rst index 90ed6c70..5c37be95 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade.rst @@ -4,15 +4,14 @@ Upgrade wallabag Upgrade on a dedicated web server --------------------------------- -The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.8`` by the last release number): +The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.1.0`` by the last release number): :: git fetch origin git fetch --tags - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console cache:clear --env=prod + git checkout 2.1.0 + ./install.sh Upgrade on a shared hosting --------------------------- diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 105e8122..4fccd0d4 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -45,20 +45,13 @@ Installation de Composer : Vous pouvez trouver des instructions spécifiques `ici (en anglais) `__. -Vous devez aussi installer node.js (via `la page de téléchargements `__), 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.1 + git checkout 2.1.0 ./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/upgrade.rst b/docs/fr/user/upgrade.rst index 1ead2c94..e3798979 100644 --- a/docs/fr/user/upgrade.rst +++ b/docs/fr/user/upgrade.rst @@ -4,15 +4,14 @@ Mettre à jour wallabag Mise à jour sur un serveur dédié -------------------------------- -La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.0.8`` par le numéro de la dernière version) : +La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.1.0`` par le numéro de la dernière version) : :: git fetch origin git fetch --tags - git checkout 2.0.8 - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console cache:clear --env=prod + git checkout 2.1.0 + ./install.sh Mise à jour sur un hébergement mutualisé ---------------------------------------- -- cgit v1.2.3 From e406a94ab6b17af1e2aefbec614b389a11fa89be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 19 Sep 2016 15:23:04 +0200 Subject: Fixed version in documentation --- README.md | 2 +- app/config/config.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 73c34ae0..ca61f029 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Then you can install wallabag by executing the following commands: ``` git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1 + git checkout 2.1.0 ./install.sh php bin/console server:run --env=prod ``` diff --git a/app/config/config.yml b/app/config/config.yml index 43e553e3..7ee0cfb8 100644 --- a/app/config/config.yml +++ b/app/config/config.yml @@ -30,7 +30,7 @@ framework: assets: ~ wallabag_core: - version: 2.1 + version: 2.1.0 paypal_url: "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9UBA65LG3FX9Y&lc=gb" languages: en: 'English' -- cgit v1.2.3