Update documentation, improve help messages

Ref #293

README.rst

@@ -69,7 +69,7 @@ To install Alignak-app:
     # To keep it free, installer is not signed, so Windows Defender SmartScreen will warn you about that.
     # Just click on "More Informations" and on "Execute anyway" to run installer.
 
-    # You can generate your own setup. Please, follow the documentation link below.
+    # You can also generate your own setup. Please, follow the documentation link below.
 
 * **Linux Users:**
 
@@ -79,12 +79,8 @@ To install Alignak-app:
     pip3 install alignak_app
 
     # First run
-    # Installed as "user"
-    ~/.local/alignak_app/bin/alignak-app.py --start   # Run application in current shell
-    ~/.local/alignak_app/bin/alignak-app.py --install # Install a daemon file
-    # Installed as "root"
-    /usr/local/aligna_app/alignak-app.py --start   # Run application in current shell
-    /usr/local/aligna_app/alignak-app.py --install # Install a daemon file
+    alignak-app-launcher --start   # Run application in current shell
+    alignak-app-launcher --install # Install a daemon file
 
     # If you've installed Alignak-app daemon, then run:
     alignak-app start
@@ -99,7 +95,7 @@ To install Alignak-app:
     # If you're under Windows, use "pip" instead of "pip3"
     pip3 install -r requirements.txt
     pip3 install . -v
-    # Then run "alignak-app.py" file
+    # Then run "app.py" file
 
 You can find more help in the documentation below.
 
@@ -116,7 +112,7 @@ Release strategy
 
 Alignak-app will *try* to follow the `Alignak-Backend <https://github.com/Alignak-monitoring-contrib/alignak-backend>`_ version.
 As of it, take care to install the same minor version on your system to ensure compatibility between all the packages.
-If your Backend is **1.1.0**, use Alignak-app **1.1.x**.
+If your Backend is **1.4.x**, use Alignak-app **1.4.x**.
 
 Bugs / Enhancements
 -------------------

alignak_app/app.py

@@ -20,8 +20,7 @@
 # along with (AlignakApp).  If not, see <http://www.gnu.org/licenses/>.
 
 """
-Alignak-App Launcher
-~~~~~~~~~~~~~~~~~~~~
+alignak-app-launcher command line interface::
 
     Usage:
         alignak-app-launcher [-h]
@@ -34,19 +33,18 @@
         -i, --install       Check installation folders and files. (All platforms)
                             Install a daemon file and autocompletion. (Linux only)
 
-    Daemon "alignak-app":
-        Option "--install" will create a bin folder in your ``HOME``, with a daemon file based on
+    Daemon [alignak-app]:
+        Option "--install" will create a bin folder in your "$HOME", with a daemon file based on
         the environment variables of your current session.
 
-        Then simply run ``alignak-app``.
+        Then simply run "alignak-app start" to launch application.
 
     Exit codes:
-        0 if required operation succeeded
+        0  if required operation succeeded
 
         22 if application detect an SSH session.
         64 if command line parameters are not used correctly
 
-    For more information, please read the documentation at http://alignak-app.readthedocs.io.
 """
 
 import os

bin/unix/alignak-app.sample.sh

@@ -48,7 +48,7 @@ APP_RELEASE_NOTES="%s"
 APP_PROJECT_URL="%s"
 APP_DOC_URL="%s"
 
-# Functions for alignak-app
+# Alignak-app functions
 usage() {
     echo "------------------------------------------"
     echo "Alignak-app, Version $APP_VERSION \n"
@@ -88,7 +88,7 @@ do_stop() {
         echo "--------------------------------------------------"
     else
         echo "--------------------------------------------------"
-        echo " $DAEMON is not running ;) "
+        echo " $DAEMON does not run ;) "
         echo "--------------------------------------------------"
     fi
 }
@@ -101,7 +101,8 @@ do_status() {
         echo "--------------------------------------------------"
     else
         echo "--------------------------------------------------"
-        echo " $DAEMON is not running ! "
+        echo " $DAEMON does not run ;) "
+        echo ""
         echo "Run '$DAEMON start' to launch Alignak-app"
         echo "--------------------------------------------------"
     fi

docs/api.rst

@@ -6,7 +6,7 @@ API
 Main Class
 ----------
 
-.. automodule:: alignak_app.app
+.. automodule:: alignak_app.alignakapp
     :members:
     :show-inheritance:
 

docs/index.rst

@@ -14,7 +14,8 @@ Documentation content:
     intro
     installer
     config
-    use
+    run
+    interface
     archi
     api
 

docs/installer.rst

@@ -46,8 +46,6 @@ You can install Alignak-app like other python libraries, with ``pip3``::
 
 The required Python modules are automatically installed, if not present on your system.
 
-If you install App as a root user (with ``sudo``), you have to run ``--install`` command before launch Alignak-App ! (see :ref:`use`)
-
 Installation (From Sources)
 ===========================
 

docs/use.rst → docs/interface.rst

@@ -1,73 +1,10 @@
-.. _use:
-
-Use Alignak-App
-###############
-
-Run "App"
-*********
-
-On Linux
-========
-
-First launch
-------------
-
-Once you have install Alignak-app, just run `alignak-app.py` file. This file should be located in::
-
-    # If install by pip as user
-    $HOME/.local/alignak_app/bin/alignak-app.py
-    # If install by pip as root
-    /usr/local/alignak_app/bin/alignak-app.py
-
-To launch application use ``--start``::
-
-    /usr/local/alignak_app/bin/alignak-app.py --start
-
-If you have set environment variables for application, they will be added to the generated daemon script (see :ref:`config`).
-
-To generate an Alignak-app daemon file, use ``--install``::
-
-    /usr/local/alignak_app/bin/alignak-app.py --install
-
-Launch daemon
--------------
-
-Once installed, just run::
-
-    alignak-app start
-
-Here is the available commands::
-
-    alignak-app {start|stop|status|restart}
-
-With no parameters, this will display help and your environment variables configuration.
-
-**Note:** To generate a new daemon file with other environment, just run ``alignak-app.py --start`` again with your new environment variables.
-
-On Windows
-==========
-
-With Installer
---------------
-
-Just launch ``Alignak-app vX.x`` shorcut on your desktop or run the ``alignak-app.exe`` located in ``C:\Program Files\Alignak-app\``.
-
-From command line
------------------
-
-If you install from sources or with pip, you just have to launch the ``alignak-app.py`` in ``bin`` folder::
-
-    python c:\Users\user\AppData\Roaming\Python\alignak_app\bin\alignak-app.py --start
-
-Obviously, it requires to keep an open command prompt on Windows.
-
-**Note:** There is no daemon available on Windows, please use provided setup.
+.. _interface:
 
 Interface
-*********
+#########
 
 Login Window
-============
+************
 
 If you have not set your configuration file, Alignak-app will display a login window by default.
 In this window, you'll be able to:
@@ -76,7 +13,7 @@ In this window, you'll be able to:
 * Type your **username** and **password** to login.
 
 Start
-=====
+*****
 
 Once you're connected, Alignak-app will start and show you a progress bar. Time to start will depend on your installation (a backend with a lot of host and services will take more time).
 
@@ -96,92 +33,110 @@ When Alignak-app has started, you'll have:
 Other menu will come in future versions.
 
 App Dock (Right part)
-=====================
+*********************
 
 When App is launched, the right part (called "dock") will contains different buttons and some container who will receive different notifications.
 
-Alignak part
-------------
+Alignak
+=======
 
 This part of dock contains informations about your connection to backend and the states of Alignak daemons.
-If you've some connection problems or if backend is restart, you'll see icons change.
+If you've some connection problems or if backend is restart, you'll be notified here.
 
-You can also see each daemon state by clicking on button with Alignak icon.
+You can also see each daemon state by clicking on button with Alignak icon, if endpoint is available in backend.
 
-Livestate part
---------------
+Finally, you can see your profile by clicking on the button
 
-In the livestate part, you'll have many buttons who let you see: hosts, user configuration, problems view (available soon) and a button to reach your WebUI if available.
+Livestate part
+==============
 
-You'll also see a resume of number of problems for hosts and services monitored in your backend.
+In the livestate part, you'll see a resume of number of problems and items monitored in your backend.
 
 Events part
------------
+===========
 
 This is one of the most interesting features of the application. You'll receive many informations in this part like alignak notifications, acknowledge or modifications you do in App.
 
 **Events:**
 
   * If you want to remove an event, simply double click on it.
-  * Full events text can be see in tooltip when you keep mouse over.
   * Some events are temporary and remove themselves.
   * Some events can be drag and drop (see below)
+  * Full events text can be see in tooltip when you keep mouse over.
 
 **Drag & Drop:**
 
-  * Events from a host or a service can be drag to in "Spy Hosts". Then App will send you regular notifications about that host.
-  * Events can also be move to host synthesis view (Panel), to display host instantly.
-
-Spy part
---------
-
-This is where you can find the list of hosts that you spy on.
-
-  * You can spy on as many hosts as you want.
-  * To stop spying on a host, just double click on it, host will be removed from list.
+  * Events from an host or a service can be drag and dropped in "Spied Hosts" tab.
+  * Events can also be moved to Host Synthesis view (Panel), to display host instantly.
 
 App Panel (Left part)
-=====================
+*********************
 
 The left part of application (called "Panel"), will display a **Hosts Synthesis View**. This is where you can see your monitored hosts and services.
 
-Host Synthesis
---------------
+Dashboard
+=========
 
-**Dashboard:**
+At the top of this window, you will find a dashboard with the number of items, for each state (OK, CRITICAL, DOWN, ACKNOWLEDGED...).
 
-At the top of this window, you will find a dashboard with the number of items, for each state (OK, CRITICAL, DOWN...).
+Host Synthesis
+==============
 
-**Host View:**
+Host View
+---------
 
 Start typing the name of a host in the search bar and App will propose to you different corresponding names.
-When you select a host, its information and the list of its services will be displayed.
+When you select a host, its informations and the list of its services will be displayed.
 
-*Services:*
+Services
+--------
 
 When a host is displayed, you will have the list of services, classified by aggregation. Click on one of them to display them.
 
 If you click on a service, a summary of its status will be displayed on the right.
 
-**Actions:**
+Actions
+-------
+
 You will then be able to perform various actions such as seeing the details of each of its services, acknowledging a problem or planning a downtime for an item (service or host).
 
 You will also have access to the host's history. It may take a while to be available.
 
 Another tab called "Problems" is used to display the problems listed by the backend (like a DOWN host or a CRITICAL service).
 
 Problems
---------
+========
 
-Other tab will display problems found by Alignak-app in backend.
+Problems tab will display problems found by Alignak-app in backend.
+This panel gathers hosts down, critical services or other issues.
 
-This will bring together down hosts, critical services or any other worries, such as an unreachable host.
+  * You'll be able to acknowledge problems or trigger downtimes.
+  * You can choose to spy an host from any item.
+  * You can display host concerned in Host Synthesis view.
 
-You'll be able to acknowledge problems or trigger downtimes.
+Spied Hosts
+===========
 
-WebUI Integration
-=================
+This is where you can find the list of hosts that you spy on.
+
+  * You can spy on as many hosts as you want.
+  * App will keep you informed about host state.
+  * When you select a spy host, App will show you the information it has collected.
+  * To stop spying on a host, just double click on it, host will be removed from list.
+
+You can also **drag & drop** spied elements to display host instantly in Host Synthesis.
+
+External Tools
+**************
+
+WebUI
+=====
 
 App also have lot of buttons which bring you to WebUI. You've to set WebUI url in configuration file to make this buttons available.
 
 App will be aware also on events trigger in WebUI in host history.
+
+GLPI
+====
+
+**Not yet implemented.**