diff options
author | Nicolas Lœuillet <nicolas@loeuillet.org> | 2016-08-25 15:28:46 +0200 |
---|---|---|
committer | Nicolas Lœuillet <nicolas@loeuillet.org> | 2016-09-19 15:20:46 +0200 |
commit | 8fed8d1bacbbcbf606a94497c5b58f49068bd6a3 (patch) | |
tree | 8e56b1503d1781899c6fb1c160f05993108366be | |
parent | 05d2d62f128df5dafa3be17d9848fb9b5b146836 (diff) | |
download | wallabag-8fed8d1bacbbcbf606a94497c5b58f49068bd6a3.tar.gz wallabag-8fed8d1bacbbcbf606a94497c5b58f49068bd6a3.tar.zst wallabag-8fed8d1bacbbcbf606a94497c5b58f49068bd6a3.zip |
Add documentation about article sharing
-rw-r--r-- | README.md | 7 | ||||
-rw-r--r-- | app/config/config.yml | 2 | ||||
-rw-r--r-- | docs/de/user/installation.rst | 2 | ||||
-rw-r--r-- | docs/en/index.rst | 1 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 16 | ||||
-rw-r--r-- | docs/en/user/share.rst | 17 | ||||
-rw-r--r-- | docs/fr/index.rst | 1 | ||||
-rw-r--r-- | docs/fr/user/installation.rst | 18 | ||||
-rw-r--r-- | docs/fr/user/share.rst | 17 | ||||
-rw-r--r-- | docs/img/user/share.png | bin | 0 -> 9435 bytes |
10 files changed, 64 insertions, 17 deletions
@@ -10,15 +10,14 @@ More informations on our website: [wallabag.org](https://wallabag.org) | |||
10 | 10 | ||
11 | # Install wallabag | 11 | # Install wallabag |
12 | 12 | ||
13 | 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). | 13 | 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. |
14 | Then you can install wallabag by executing the following commands: | 14 | Then you can install wallabag by executing the following commands: |
15 | 15 | ||
16 | ``` | 16 | ``` |
17 | git clone https://github.com/wallabag/wallabag.git | 17 | git clone https://github.com/wallabag/wallabag.git |
18 | cd wallabag | 18 | cd wallabag |
19 | git checkout 2.0.8 | 19 | git checkout 2.1 |
20 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 20 | ./install.sh |
21 | php bin/console wallabag:install --env=prod | ||
22 | php bin/console server:run --env=prod | 21 | php bin/console server:run --env=prod |
23 | ``` | 22 | ``` |
24 | 23 | ||
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: | |||
30 | assets: ~ | 30 | assets: ~ |
31 | 31 | ||
32 | wallabag_core: | 32 | wallabag_core: |
33 | version: 2.0.8 | 33 | version: 2.1 |
34 | paypal_url: "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9UBA65LG3FX9Y&lc=gb" | 34 | paypal_url: "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9UBA65LG3FX9Y&lc=gb" |
35 | languages: | 35 | languages: |
36 | en: 'English' | 36 | 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: | |||
46 | 46 | ||
47 | curl -s http://getcomposer.org/installer | php | 47 | curl -s http://getcomposer.org/installer | php |
48 | 48 | ||
49 | Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden: | 49 | Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden. |
50 | 50 | ||
51 | Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: | 51 | Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: |
52 | 52 | ||
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: | |||
40 | user/errors_during_fetching | 40 | user/errors_during_fetching |
41 | user/annotations | 41 | user/annotations |
42 | user/download_articles | 42 | user/download_articles |
43 | user/share | ||
43 | user/filters | 44 | user/filters |
44 | user/tags | 45 | user/tags |
45 | user/android | 46 | 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 | |||
37 | On a dedicated web server (recommended way) | 37 | On a dedicated web server (recommended way) |
38 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 38 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
39 | 39 | ||
40 | 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``). | 40 | 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``). |
41 | 41 | ||
42 | Install Composer: | 42 | Install Composer: |
43 | 43 | ||
@@ -45,7 +45,14 @@ Install Composer: | |||
45 | 45 | ||
46 | curl -s http://getcomposer.org/installer | php | 46 | curl -s http://getcomposer.org/installer | php |
47 | 47 | ||
48 | You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__: | 48 | You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__. |
49 | |||
50 | 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: | ||
51 | |||
52 | :: | ||
53 | |||
54 | npm install -g bower | ||
55 | npm install -g grunt-cli | ||
49 | 56 | ||
50 | To install wallabag itself, you must run the following commands: | 57 | To install wallabag itself, you must run the following commands: |
51 | 58 | ||
@@ -53,9 +60,8 @@ To install wallabag itself, you must run the following commands: | |||
53 | 60 | ||
54 | git clone https://github.com/wallabag/wallabag.git | 61 | git clone https://github.com/wallabag/wallabag.git |
55 | cd wallabag | 62 | cd wallabag |
56 | git checkout 2.0.8 | 63 | git checkout 2.1 |
57 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 64 | ./install.sh |
58 | php bin/console wallabag:install --env=prod | ||
59 | 65 | ||
60 | To start PHP's build-in server and test if everything did install correctly, you can do: | 66 | To start PHP's build-in server and test if everything did install correctly, you can do: |
61 | 67 | ||
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 @@ | |||
1 | Share articles | ||
2 | ============== | ||
3 | |||
4 | When you're reading an article, you can share it. Just click on the share button: | ||
5 | |||
6 | .. image:: ../../img/user/share.png | ||
7 | :alt: share article | ||
8 | :align: center | ||
9 | |||
10 | Now, you can share the article: | ||
11 | |||
12 | - with a public URL (you'll have a light view of the article) | ||
13 | - with a tweet | ||
14 | - into your Shaarli | ||
15 | - with a post in Diaspora* | ||
16 | - to Carrot | ||
17 | - 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 : | |||
41 | user/errors_during_fetching | 41 | user/errors_during_fetching |
42 | user/annotations | 42 | user/annotations |
43 | user/download_articles | 43 | user/download_articles |
44 | user/share | ||
44 | user/filters | 45 | user/filters |
45 | user/tags | 46 | user/tags |
46 | 47 | ||
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 | |||
35 | Sur un serveur dédié (méthode conseillée) | 35 | Sur un serveur dédié (méthode conseillée) |
36 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 36 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
37 | 37 | ||
38 | 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``). | 38 | 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``). |
39 | 39 | ||
40 | Installation de Composer : | 40 | Installation de Composer : |
41 | 41 | ||
@@ -43,17 +43,23 @@ Installation de Composer : | |||
43 | 43 | ||
44 | curl -s http://getcomposer.org/installer | php | 44 | curl -s http://getcomposer.org/installer | php |
45 | 45 | ||
46 | Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__ : | 46 | Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__. |
47 | 47 | ||
48 | Pour installer wallabag, vous devez exécuter ces deux commandes : | 48 | 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: |
49 | |||
50 | :: | ||
51 | |||
52 | npm install -g bower | ||
53 | npm install -g grunt-cli | ||
54 | |||
55 | Pour installer wallabag, vous devez exécuter ces commandes : | ||
49 | 56 | ||
50 | :: | 57 | :: |
51 | 58 | ||
52 | git clone https://github.com/wallabag/wallabag.git | 59 | git clone https://github.com/wallabag/wallabag.git |
53 | cd wallabag | 60 | cd wallabag |
54 | git checkout 2.0.8 | 61 | git checkout 2.1 |
55 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | 62 | ./install.sh |
56 | php bin/console wallabag:install --env=prod | ||
57 | 63 | ||
58 | Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : | 64 | Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : |
59 | 65 | ||
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 @@ | |||
1 | Partager des articles | ||
2 | ===================== | ||
3 | |||
4 | Quand vous lisez un article, vous pouvez le partager. Cliquez sur le bouton de partage : | ||
5 | |||
6 | .. image:: ../../img/user/share.png | ||
7 | :alt: partager un article | ||
8 | :align: center | ||
9 | |||
10 | Vous pouvez maintenant le partager : | ||
11 | |||
12 | - avec une URL publique (vous obtiendrez une vue allégée de l'article) | ||
13 | - avec un tweet | ||
14 | - dans votre Shaarli | ||
15 | - avec un message dans Diaspora* | ||
16 | - sur Carrot | ||
17 | - avec un email | ||
diff --git a/docs/img/user/share.png b/docs/img/user/share.png new file mode 100644 index 00000000..4cfe9edb --- /dev/null +++ b/docs/img/user/share.png | |||
Binary files differ | |||