aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2016-09-20 14:29:16 +0200
committerGitHub <noreply@github.com>2016-09-20 14:29:16 +0200
commit32e95760f567e5849dd71aaba9aabb1ab56bcd0a (patch)
tree1bf0169d4c3a41d0a57a569c3a36a7c1f4d19033 /docs/en
parent5074e7d4fa631af2b6f5f2f28b1d57a27039bb0e (diff)
parente406a94ab6b17af1e2aefbec614b389a11fa89be (diff)
downloadwallabag-32e95760f567e5849dd71aaba9aabb1ab56bcd0a.tar.gz
wallabag-32e95760f567e5849dd71aaba9aabb1ab56bcd0a.tar.zst
wallabag-32e95760f567e5849dd71aaba9aabb1ab56bcd0a.zip
Merge pull request #2239 from wallabag/documentation-2.1
Update documentation with new features for 2.1
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/index.rst1
-rw-r--r--docs/en/user/installation.rst9
-rw-r--r--docs/en/user/share.rst17
-rw-r--r--docs/en/user/upgrade.rst7
4 files changed, 25 insertions, 9 deletions
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..8e9f71d4 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -37,7 +37,7 @@ Installation
37On a dedicated web server (recommended way) 37On a dedicated web server (recommended way)
38~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 38~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39 39
40wallabag 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``). 40wallabag 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
42Install Composer: 42Install Composer:
43 43
@@ -45,7 +45,7 @@ Install Composer:
45 45
46 curl -s http://getcomposer.org/installer | php 46 curl -s http://getcomposer.org/installer | php
47 47
48You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__: 48You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
49 49
50To install wallabag itself, you must run the following commands: 50To install wallabag itself, you must run the following commands:
51 51
@@ -53,9 +53,8 @@ To install wallabag itself, you must run the following commands:
53 53
54 git clone https://github.com/wallabag/wallabag.git 54 git clone https://github.com/wallabag/wallabag.git
55 cd wallabag 55 cd wallabag
56 git checkout 2.0.8 56 git checkout 2.1.0
57 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist 57 ./install.sh
58 php bin/console wallabag:install --env=prod
59 58
60To start PHP's build-in server and test if everything did install correctly, you can do: 59To start PHP's build-in server and test if everything did install correctly, you can do:
61 60
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 @@
1Share articles
2==============
3
4When 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
10Now, 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/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
4Upgrade on a dedicated web server 4Upgrade on a dedicated web server
5--------------------------------- 5---------------------------------
6 6
7The 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): 7The 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):
8 8
9:: 9::
10 10
11 git fetch origin 11 git fetch origin
12 git fetch --tags 12 git fetch --tags
13 git checkout 2.0.8 13 git checkout 2.1.0
14 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist 14 ./install.sh
15 php bin/console cache:clear --env=prod
16 15
17Upgrade on a shared hosting 16Upgrade on a shared hosting
18--------------------------- 17---------------------------