fixed #224 and fixed #226

foxmask · Oct 19, 2017 · 3df05a0 · 3df05a0
1 parent dda0518
commit 3df05a0
Show file tree

Hide file tree

Showing 22 changed files with 383 additions and 212 deletions.
diff --git a/docs/admin_guide/index.rst b/docs/admin_guide/index.rst
@@ -1,35 +1,28 @@
+.. _index:
+
 Administation Guide
 ===================
 
 That part of the guide will explain the following topics:
 
 * How to create, add a new service
-* For the users of your TriggerHappy instance, What's happened when you
-disable a service.
+* For the users of your TriggerHappy instance, What's happened when you disable a service.
 
 
 How to create, add a new service
 --------------------------------
 
 from the admin panel at http://127.0.0.1:8000/admin/
 
-Under the paragraph "Trigger Happy", select "Services", then press "add
-service". Choose the new service name and fill the fields.
-If you don't know how to fill them, see the "Configuration
-from the Admin panel" for each of the service from the :ref:`Services list<services>`
-
+Under the paragraph "Trigger Happy", select "Services", then press "add service".
+Choose the new service name and fill the fields.
+If you don't know how to fill them, see the "Configuration from the Admin panel" for each of the service from the :ref:`Services list<services>`
 
 
 Disabling a service, what consequences
 --------------------------------------
 
 When you turn off a given service:
 
-* if users did not use it before, the service will desappears from the
-dropdown list of the services, a user can add from the activated services page
-
-* if users already used it before, then the triggers that use the service,
-will be disabled, the line of the trigger will become inert, impossible to
-interact with it, and the trigger-happy engine wont handle it all at.
-
-
+* if users did not use it before, the service will desappears from the dropdown list of the services, a user can add from the activated services page
+* if users already used it before, then the triggers that use the service, will be disabled, the line of the trigger will become inert, impossible to interact with it, and the trigger-happy engine wont handle it all at.
diff --git a/docs/index.rst b/docs/index.rst
@@ -76,7 +76,6 @@ The Installation Guide
 ----------------------
 
 .. toctree::
-  :maxdepth: 2
 
    installation_guide/quickstart
    installation_guide/installation
@@ -92,14 +91,12 @@ The User Guide
 --------------
 
 .. toctree::
-  :maxdepth: 2
 
    user_guide/index
 
 The Administration Guide
 ------------------------
 
 .. toctree::
-  :maxdepth: 2
 
    admin_guide/index
diff --git a/docs/installation_guide/configuration.rst b/docs/installation_guide/configuration.rst
@@ -1,3 +1,5 @@
+.. _configuration:
+
 =============
 Configuration
 =============
@@ -118,7 +120,7 @@ comment the line of the service you do not need, by adding a # before the single
 setup .env file
 ---------------
 
-if you do not have any .env file in your project folder, then copy the django_th/env.sample to .env 
+if you do not have any .env file in your project folder, then copy the django_th/env.sample to .env
 
 if you do have an existing .env file, copy the content of django_th/env.sample into it
 
@@ -134,21 +136,21 @@ then the parameters are the following
     DJANGO_TH_FIRE=True
     DJANGO_TH_DIGEST_EVENT=False
     DJANGO_TH_SHARING_MEDIA=True
-    
+
     TH_EVERNOTE_SANDBOX=False
     TH_EVERNOTE_CONSUMER_KEY=
     TH_EVERNOTE_CONSUMER_SECRET=
-    
+
     TH_GITHUB_USERNAME=
     TH_GITHUB_PASSWORD=
     TH_GITHUB_CONSUMER_KEY=
     TH_GITHUB_CONSUMER_SECRET=
-    
+
     TH_POCKET_CONSUMER_KEY=
 
     TH_PUSHBULLET_CLIENT_ID=
     TH_PUSHBULLET_CLIENT_SECRET=
-    
+
     TH_TODOIST_CLIENT_ID=
     TH_TODOIST_CLIENT_SECRET=
 

diff --git a/docs/installation_guide/evernote.rst b/docs/installation_guide/evernote.rst
@@ -7,16 +7,30 @@ Service Description:
 This service allows to take notes, photos, schedule things and so on
 
 
+User Guide
+----------
+
+Activation of the service from the page http://127.0.0.1:8000/th/service/add/
+
+.. image:: https://github.com/foxmask/django-th/blob/master/docs/public_service_wallabag_add.png
+   :alt: My Activated Services
+
+then in the form, select Evernote in the dropdown box and press "Activate it"
+
+
+Installation Guide
+------------------
+
 Requesting a key
-----------------
+~~~~~~~~~~~~~~~~
 
 On https://dev.evernote.com/ at the top right of the page, click on 'get an api key'.
 
 Fill the form and get the informations that you will need to provide in the next paragraph
 
 
 The service keys
-----------------
+~~~~~~~~~~~~~~~~
 
 Here are the modifications of .env file you will need to make to be able to use your credentials with Evernote
 
@@ -28,7 +42,7 @@ Here are the modifications of .env file you will need to make to be able to use
 
 
 Configuration from the Admin panel
-----------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 http://127.0.0.1:8000/admin/django_th/servicesactivated/
 

diff --git a/docs/installation_guide/github.rst b/docs/installation_guide/github.rst
@@ -7,16 +7,30 @@ Service Description:
 Powerful collaboration, code review, and code management for open source and private projects. Public projects are always free.
 
 
+User Guide
+----------
+
+Activation of the service from the page http://127.0.0.1:8000/th/service/add/
+
+.. image:: https://github.com/foxmask/django-th/blob/master/docs/public_service_wallabag_add.png
+   :alt: My Activated Services
+
+then in the form, select Github in the dropdown box and press "Activate it"
+
+
+Installation Guide
+------------------
+
 Requesting a key
-----------------
+~~~~~~~~~~~~~~~~
 
 On https://github.com/settings/developers, click on "New Oauth App" button at right.
 
 Fill the form and get the informations that you will need to provide in the next paragraph
 
 
 The service keys
-----------------
+~~~~~~~~~~~~~~~~
 
 Here are the modifications of .env file you will need to make to be able to use your credentials with Github
 
@@ -28,7 +42,7 @@ Here are the modifications of .env file you will need to make to be able to use
     TH_GITHUB_CONSUMER_SECRET= 'your consumer secret'
 
 Configuration from the Admin panel
-----------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 http://127.0.0.1:8000/admin/django_th/servicesactivated/
 

diff --git a/docs/installation_guide/installation.rst b/docs/installation_guide/installation.rst
@@ -1,3 +1,5 @@
+.. _installation:
+
 ============
 Installation
 ============
@@ -14,7 +16,7 @@ We just create a virtualenv with python 3.6 (or 3.5)
     python3.6 -m venv myproject
     cd $_
     source bin/activate
-    
+
 then you can continue with one of the two choice "From GitHub" or "From Pypi"
 
 
@@ -25,7 +27,7 @@ Installation from an existing project
 
     cd /to/the/path/of/my/existing/project
     source bin/activate   # (if you have a virtualenv)
- 
+
 then you can continue with one of the two choice "From GitHub" or "From Pypi"
 
 
@@ -122,3 +124,7 @@ Pandoc is also needed of the system, that you can install on a Debian/Ubuntu sys
 * for twitter support `twython <https://github.com/ryanmcgrath/twython>`_
 * for wallabag support `wallabag_api <https://pypi.python.org/pypi/wallabag_api>`_
 
+Advice
+------
+
+If you plan to setup Trigger Happy for you and a group of friends, I suggest you to install https://www.intenct.nl/projects/django-allauth/
diff --git a/docs/installation_guide/instapush.rst b/docs/installation_guide/instapush.rst
@@ -6,55 +6,22 @@ Service Description:
 
 Notification service
 
+User Guide
+----------
 
-modifications of settings.py
-----------------------------
+Activation of the service from the page http://127.0.0.1:8000/th/service/add/
 
-uncomment the following line
+.. image:: https://github.com/foxmask/django-th/blob/master/docs/public_service_wallabag_add.png
+   :alt: My Activated Services
 
-.. code-block:: python
+then in the form, select Instapush in the dropdown box then in the form, just fill the user token, then press "Activate it"
 
-    INSTALLED_APPS = (
-        # 'th_instapsuh',
-    )
 
-to get
-
-.. code-block:: python
-
-    INSTALLED_APPS = (
-        'th_instapsuh',
-    )
-
-modifications of th_settings.py
--------------------------------
-
-uncomment the following line
-
-.. code-block:: python
-
-    TH_SERVICES = (
-        # 'th_instapush.my_instapush.ServiceInstapush',
-    )
-
-to get
-
-.. code-block:: python
-
-    TH_SERVICES = (
-        'th_instapush.my_instapush.ServiceInstapush',
-    )
-
-
-creation of the table of the services
--------------------------------------
-
-enter the following command
-
-.. code-block:: bash
-
-    python manage.py migrate
+Installation Guide
+------------------
 
+Requesting a key
+~~~~~~~~~~~~~~~~
 
 Configuration from the Admin panel
 ----------------------------------

diff --git a/docs/installation_guide/mastodon.rst b/docs/installation_guide/mastodon.rst
@@ -6,16 +6,36 @@ Service Description:
 
 Your self-hosted, globally interconnected microblogging community
 
+User Guide
+----------
 
+Activation of the service from the page http://127.0.0.1:8000/th/service/add/
+
+.. image:: https://github.com/foxmask/django-th/blob/master/docs/public_service_wallabag_add.png
+   :alt: My Activated Services
+
+then in the form, select Mastodon in the dropdown box, and fill all the fields with the information you can have from mastodon :
+
+* in Nickname ; put your mastodon nickname
+* in Password ; put your mastodon password
+* in Client ID ; put the "Client key"
+* in Client Secret ; put the "Client Secret"
+* in the Host ; put the host of the mastodon instance
+
+Then press "Activate it"
+
+
+Installation Guide
+------------------
 
 Requesting a key
-----------------
+~~~~~~~~~~~~~~~~
 
 On https://<your mastodon instance>/settings/applications/new fill the form and get the information to be used from the page of the activation of the service http://127.0.0.1:8000/th/service/add/
 
 
 Configuration from the Admin panel
-----------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 http://127.0.0.1:8000/admin/django_th/servicesactivated/
 

diff --git a/docs/installation_guide/migration.rst b/docs/installation_guide/migration.rst
@@ -1,3 +1,5 @@
+.. _migration:
+
 =================================
 MIGRATIONS from 0.10.x to 0.11.x:
 =================================

diff --git a/docs/installation_guide/pocket.rst b/docs/installation_guide/pocket.rst
@@ -6,23 +6,37 @@ Service Description:
 
 a "Read it Later" service
 
+User Guide
+----------
+
+Activation of the service from the page http://127.0.0.1:8000/th/service/add/
+
+.. image:: https://github.com/foxmask/django-th/blob/master/docs/public_service_wallabag_add.png
+   :alt: My Activated Services
+
+then in the form, select Pocket in the dropdown box and press "Activate it"
+
+
+Installation Guide
+------------------
+
 Requesting a key
-----------------
+~~~~~~~~~~~~~~~~
 
 On https://getpocket.com/developer/ , click on 'create a new app'
 
 Fill the form and get the information that you will need to provide in the next paragraph
 
 
 The service keys
-----------------
+~~~~~~~~~~~~~~~~
 
 .. code-block:: python
 
     TH_POCKET_CONSUMER_KEY= 'your pocket key'
 
 Configuration from the Admin panel
-----------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 http://127.0.0.1:8000/admin/django_th/servicesactivated/