Merge pull request #1495 from wallabag/v2-docs

add docs

4 files changed, 203 insertions, 0 deletions

diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst
new file mode 100644
index 00000000..60aae4e5
--- /dev/null
+++ b/docs/en/user/configuration.rst
@@ -0,0 +1,61 @@
+Configuration
+=============
+
+Now you're logged in, it's time to configure your account as you want.
+
+Click on ``Config`` menu. You have four tabs: ``Settings``, ``RSS``, ``User information`` and ``Password``.
+
+Settings
+--------
+
+Theme
+~~~~~
+
+wallabag is customizable. You can choose your prefered theme here. You can also create a new one, a chapter is dedicated for this. The default theme is ``Material``, it's the theme used in the documentation screenshots. 
+
+Items per page
+~~~~~~~~~~~~~~
+
+You can change the number of articles displayed on each page.
+
+Language
+~~~~~~~~
+
+You can change the language of wallabag interface.
+
+RSS
+---
+
+wallabag provides RSS feeds for each article status: unread, starred and archive.
+
+Firstly, you need to create a personal token: click on ``Create your token``.
+It's possible to change your token by clicking on ``Reset your token``.
+
+Now you have three links, one for each status: add them into your favourite RSS reader.
+
+You can also define how many articles you want in each RSS feed (default value: 50).
+
+User information
+----------------
+
+You can change your name, your email address and enable ``Two factor authentication``.
+
+Two factor authentication
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    Two-factor authentication (also known as 2FA) is a technology patented in 1984 that provides identification of users by means of the combination of two different components.
+
+https://en.wikipedia.org/wiki/Two-factor_authentication
+
+If you enable 2FA, each time you want to login to wallabag, you'll receive a code by email. You have to put this code on the following form.
+
+.. image:: ../../img/user/2FA_form.png
+   :alt: Two factor authentication
+   :align: center
+
+If you don't want to receive a code each time you want to login, you can check the ``I'm on a trusted computer`` checkbox: wallabag will remember you for 15 days.
+
+Password
+--------
+
+You can change your password here.
diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst
new file mode 100644
index 00000000..11fe304c
--- /dev/null
+++ b/docs/en/user/create_account.rst
@@ -0,0 +1,43 @@
+Create an account
+=================
+
+On the login page, click on ``Register`` button.
+
+.. image:: ../../img/user/registration_form.png
+   :alt: Registration form
+   :align: center
+
+You have to fill the form. Please sure to type a valid email address, we'll send you an activation email.
+
+.. image:: ../../img/user/sent_email.png
+   :alt: Email was sent to activate account
+   :align: center
+
+Check your inbox, you now have a new mail with a link like this ``http://wallabag/register/confirm/Ba19wokGovN-DdBQNfg4YgRkUQWRP4-k2g0Bk-hBTX4``. Click on it to activate your account.
+
+Your account is now activated.
+
+.. image:: ../../img/user/activated_account.png
+   :alt: Welcome on board!
+   :align: center
+
+Frequently asked questions
+--------------------------
+
+I can't valid the registration form
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Make sure that all fields are well filled:
+
+* valid email address
+* same passwords in two fields
+
+I don't receive my activation email
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Are you sure your email address was correct? Did you check your spams folder?
+
+When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``.
+~~~~~~~~~~~~~~~
+
+You already enabled your account or the URL of the activation email is wrong.
diff --git a/docs/en/user/first_article.rst b/docs/en/user/first_article.rst
new file mode 100644
index 00000000..4e6735c6
--- /dev/null
+++ b/docs/en/user/first_article.rst
@@ -0,0 +1,79 @@
+Save your first article
+=======================
+
+The main purpose of wallabag is to save web articles. You have many ways to do it.
+
+By using a bookmarklet
+----------------------
+
+On the ``Howto`` page, you have a ``Bookmarklet`` tab. Drag and drop the ``bag it!`` link to your bookmarks bar of your browser.
+
+Now, each time you're reading an article on the web and you want to save it, click on the ``bag it!`` link in your bookmarks bar. The article is saved.
+
+By using the classic form
+-------------------------
+
+In the top bar of your screen, you have 3 icons. With the first one, a plus sign, you can easily save a new article.
+
+.. image:: ../../img/user/topbar.png
+   :alt: Top bar
+   :align: center
+
+Click on it to display a new field, paste the article URL inside and press your ``Return`` key. The article is saved.
+
+By using a browser add-on
+-------------------------
+
+Firefox
+~~~~~~~
+
+Firefox Classic Add-on
+^^^^^^^^^^^^^^^^^^^^^^
+
+Download the Firefox add-on at `addons.mozilla.org`_ and install it like
+any other Firefox add-on.
+
+In the add-on’s settings, fill the complete URL of your installation of
+wallabag or your Framabag account.
+
+Personalize the Firefox toolbar to add wallabag (**W** icon). When you
+find an article you want to save, click on this icon: a new window will
+open to add the article and will close itself automatically.
+
+Firefox Social API Service
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+*Available from wallabag v1.9.1 only*
+
+You will need an https connection to use this. It’s a Firefox
+`requirement`_, sorry.
+
+With Firefox 29+ versions, your browser comes with an integrated
+interface to share things to multiple social services directly from your
+browser. In the Firefox interface, it is shown a paper plane-like icon
+that you will use to share a page, which means here, save an article.
+You can add the service by going into the Config page of wallabag, then
+click on Mozilla Services Social API Extension. You must also accept to
+use Firefox Services.
+
+Chrome
+~~~~~~
+
+By using your smarphone application
+-----------------------------------
+
+Android
+~~~~~~~
+
+Firefox OS
+~~~~~~~~~~
+
+Windows Phone
+~~~~~~~~~~~~~
+
+iOS
+~~~
+
+
+.. _addons.mozilla.org: https://addons.mozilla.org/firefox/addon/wallabag/
+.. _requirement: https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Social_API/Manifest#Manifest_Contents
diff --git a/docs/en/user/login.rst b/docs/en/user/login.rst
new file mode 100644
index 00000000..1b6b8875
--- /dev/null
+++ b/docs/en/user/login.rst
@@ -0,0 +1,20 @@
+Login
+=====
+
+Your account is now enabled, congratulations!
+
+To login to wallabag, fill the form on login page.
+
+If you are on your personal computer and you want to stay connected, you can check the ``Keep me logged in`` checkbox: wallabag will remember you for one year.
+
+.. image:: ../../img/user/login_form.png
+   :alt: Login form
+   :align: center
+
+Frequently asked questions
+--------------------------
+
+I forgot my password
+~~~~~~~~~~~~~~~~~~~~
+
+You can reset your password by clicking on ``Forgot your password?`` link, on the login page. Then, fill the form with your email address