fix

ExtensiveAutomation · Apr 23, 2018 · 2bee6bb · 2bee6bb
1 parent ec6b4f9
commit 2bee6bb
Show file tree

Hide file tree

Showing 15 changed files with 194 additions and 194 deletions.
diff --git a/docs/admin/admin.rst b/docs/admin/admin.rst
@@ -4,7 +4,7 @@
 Start/Stop of the server
 ~~~~~~~~~~~~~~~~~~~~~~
 
-The server can be controled with the following command``xtctl``.
+The server can be controled with the following command ``xtctl``.
 This command enables to
  - start or stop the server
  - check the status
@@ -123,7 +123,7 @@ Automatic backups
 ~~~~~~~~~~~~~~~~~~~~~~
 
 The solution make a backup of all tests, adapters and libraries every days.
-Backups are stored in the folder ``opt/xtc/current/Var/Backups``.
+Backups are stored in the folder ``/opt/xtc/current/Var/Backups``.
 
 The interval of backup can be configured from the section ``Backups`` in the file ``settings.ini``.
 

diff --git a/docs/admin/install.rst b/docs/admin/install.rst
@@ -13,7 +13,7 @@ Automatic mode
      - access to official repositories is available
      - using a Linux CentOS 6/7 or RedHat system
      
-Installation of the solution can be done using the `` install.sh`` script in the tar.gz.
+Installation of the solution can be done using the ``install.sh`` script in the tar.gz.
 If the prerequisites are respected then the installation will be done in automatic mode, that is to say that the missing packets
 will be recovered automatically.
 
@@ -69,9 +69,9 @@ Example to check if the server is working properly.
 
 The server is accessible at the address indicated at the end of the installation.
 It is possible to use no fault accounts to connect:
-  - user `` admin``
-  - user `` test``
-  - user `` monitor``
+  - user ``admin``
+  - user ``test``
+  - user ``monitor``
 
 .. note :: The default accounts do not have a password.
 
@@ -128,9 +128,9 @@ Example to check if the server is working properly.
 
 The server is accessible at the address indicated at the end of the installation.
 It is possible to use the default accounts to log in:
-  - user `` admin``
-  - user `` test``
-  - user `` monitor``
+  - user ``admin``
+  - user ``test``
+  - user ``monitor``
 
 .. note :: The default accounts do not have a password.
 
@@ -160,18 +160,18 @@ After retrieving the sources from github you have to recompose the different dir
 | web-client       | </opt..>/Web                  |
 +------------------+-------------------------------+
 
-** Preparation of the database **
+**Preparation of the database**
 
-To initialize the database, execute the "add-bdd.py" scripts available in the `` Scripts / database`` directory.
+To initialize the database, execute the "add-bdd.py" scripts available in the ``/Scripts/database`` directory.
 
-** Starting the server **
+**Starting the server**
 
-Run the `` python run`` scripts available at the root of the `` / opt / xtc / vXXX / `` directory.
+Run the ``python run`` scripts available at the root of the ``/opt/xtc/vXXX/`` directory.
 
 Update
 ~~~~~~~~~~~
 
-The server update is possible by running the script ``. / Update.sh``
+The server update is possible by running the script ``./Update.sh``
 Old tests, adapters and users are automatically migrated.
 
 .. code-block:: bash
@@ -234,7 +234,7 @@ Rollback
 ~~~~~~~~~~~
 
 Backtracking is possible to earlier versions already installed on the server.
-Run the `` rollback.sh`` script with the previous version.
+Run the ``rollback.sh`` script with the previous version.
 
 .. code-block:: bash
 
@@ -256,7 +256,7 @@ Run the `` rollback.sh`` script with the previous version.
 Uninstall
 ~~~~~~~~~~~~~~
 
-Uninstalling the product can be done using the ``. / Uninstall.sh`` script in the installation package.
+Uninstalling the product can be done using the ``./Uninstall.sh`` script in the installation package.
 
 .. code-block:: bash
 
@@ -281,7 +281,7 @@ Uninstalling the product can be done using the ``. / Uninstall.sh`` script in th
 	- Uninstallation completed successfully!
 	=========================================================================
 
-.. note :: It is possible to use the `` force`` mode if an error occurs during the uninstallation.
+.. note :: It is possible to use the ``force`` mode if an error occurs during the uninstallation.
 
 Client
 ------
@@ -335,7 +335,7 @@ The toolbox can be retrieved from the website https://www.extensiveautomation.or
 
 .. image:: /_static/images/webinterface/web_overview_pkgs3.png
 
-Then you have to decompress it and run the `` ExtensiveTestingToolbox.exe`` file
+Then you have to decompress it and run the ``ExtensiveTestingToolbox.exe`` file
 
 .. image:: /_static/images/toolbox/toolbox_portable.png
 

diff --git a/docs/admin/projects.rst b/docs/admin/projects.rst
@@ -4,7 +4,7 @@ Projects
 The solution is multi-project. It is therefore possible to organize the tests by projects and grant access rights for
 users.
 
-.. note :: The `` Common`` project exists by default, it is accessible by all users and can not be deleted.
+.. note:: The ``Common`` project exists by default, it is accessible by all users and can not be deleted.
 
 Add a project
 -----------------
@@ -22,7 +22,7 @@ This action can be done throught the web interface or the web api.
 
 .. image:: /_static/images/webinterface/delete_project.png
 
-.. note :: If the project is associated with a user, deletion is not allowed.
+.. note:: If the project is associated with a user, deletion is not allowed.
 
 Link a project to a user
 ------------------------

diff --git a/docs/admin/troubleshooting.rst b/docs/admin/troubleshooting.rst
@@ -7,21 +7,21 @@ Logs
 Server
 ~~~~~~~
 
-The server logs are stored on `` / opt / xtc / current / Var / Logs / ``.
-The logs are set in `` INFO`` mode by default.
+The server logs are stored on ``/opt/xtc/current/Var/Logs/``.
+The logs are set in ``INFO`` mode by default.
 The DEBUG level can be activated from the `` settings.ini`` file.
 
 .. code-block::
     [Trace]
     level=DEBUG
 
-.. note :: It is possible to change the level of logs by doing an `` xtcl reload``
+.. note :: It is possible to change the level of logs by doing an ``xtcl reload``
 
 Client
 ~~~~~~~
 
-The client logs are available in `` <Program Files> / Extensive Testing Client / Logs / ``
-The logs are set in `` INFO`` mode by default.
+The client logs are available in ``<Program Files> /Extensive Testing Client/Logs/``
+The logs are set in ``INFO`` mode by default.
 
 The DEBUG level can be activated from the client preferences.
 
@@ -32,10 +32,10 @@ The DEBUG level can be activated from the client preferences.
 Toolbox
 ~~~~~~~~~~~~~~
 
-The logs in the toolbox are available in `` <Program Files> / Extensive Testing Toolbox / Logs / ``
-The logs are set in `` INFO`` mode by default.
+The logs in the toolbox are available in ``<Program Files>/Extensive Testing Toolbox/Logs/``
+The logs are set in ``INFO`` mode by default.
 
-The DEBUG level can be activated from the `` settings.ini`` file.
+The DEBUG level can be activated from the ``settings.ini`` file.
 
 .. code-block::
     [Trace]
@@ -51,16 +51,16 @@ Frequently Asked Questions
 How to change the listening port (tcp / 443) of the server?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~
 
-Edit the `` / etc / httpd / conf.d / extensivetesting.conf`` file and change the listening port of the virtual host 443.
-Do not forget to modify the `` /etc/httpd/conf/httpd.conf`` file to add the new listening port.
+Edit the ``/etc/httpd/conf.d/extensivetesting.conf`` file and change the listening port of the virtual host 443.
+Do not forget to modify the ``/etc/httpd/conf/httpd.conf`` file to add the new listening port.
 
 .. note :: An apache restart is needed.
 
 How to change the connection port of the client?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The destination port can be changed from the client preferences.
-Or directly from the `` settings.ini`` file.
+Or directly from the ``settings.ini`` file.
 
 .. image:: /_static/images/client/preferences_network_ports.png
 
@@ -75,27 +75,27 @@ View the server version?
 What to do if the server installation does not work?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~
 
-The server installation process is logged in an `` install.log`` file in the directory after extracting the package.
+The server installation process is logged in an ``install.log`` file in the directory after extracting the package.
 It is necessary to look for the error messages present in the file.
 
 What if my connection to the server does not work?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~
 
 If the connection from the client to the server does not work, an analysis is necessary.
 
-The first SLR to have is to connect to the server in SSH and execute the `` xtctl status`` command to check if the server is running.
+The first SLR to have is to connect to the server in SSH and execute the ``xtctl status`` command to check if the server is running.
 
 1. If the server is running then check:
   - network connectivity in the client and the server
   - a firewall blocking the https flow (443)
 
 2. If the network connectivity is good and the server is working (or not), check the logs.
-The file is available in the `` / opt / xtc / current / Var / Logs / output.log`` directory. You must look for messages of type `` ERROR``
+The file is available in the ``/opt/xtc/current/Var/Logs/output.log`` directory. You must look for messages of type ``ERROR``
 
 How to fix the error "hping3 is not installed"?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~
 
-This error occurs while running a test when the `` Pinger`` adapter is used.
+This error occurs while running a test when the ``Pinger`` adapter is used.
 Indeed requires to have the hping3 system library installed on the server.
 
 You have to retrieve the sources from https://github.com/antirez/hping and compile them:
@@ -112,8 +112,8 @@ You have to retrieve the sources from https://github.com/antirez/hping and compi
 How to install the server in a specific directory?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~
 
-By default, the server installs in the directory `` / opt / xtc / ``, it is possible to change this directory
-at installation time by changing the `` INSTALL`` key in the `` default.cfg`` file
+By default, the server installs in the directory ``/opt/xtc/``, it is possible to change this directory
+at installation time by changing the ``INSTALL`` key in the ``default.cfg`` file
 
 .. code-block:: bash
   
@@ -123,7 +123,7 @@ Server installation remains stuck on adding external libraries
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
 
 Before starting the server installation, check that the yum service is not already running.
-If so, the installation script will remain blocked until `` yum`` is available. This issue
+If so, the installation script will remain blocked until ``yum`` is available. This issue
 Usually happens when the server is installed in graphical mode.
 
 In the logs, we can observe the following error:
@@ -137,7 +137,7 @@ In the logs, we can observe the following error:
       Started: Tue Nov  1 11:09:25 2016 - 00:42 ago
       State  : Sleeping, pid: 3293
 
-To solve this problem, you must stop the program that already uses `` yum``.
+To solve this problem, you must stop the program that already uses ``yum``.
 
 Can not navigate in the web interface
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/admin/users.rst b/docs/admin/users.rst
@@ -20,7 +20,7 @@ The creation of a user requires at least the following parameters and can be don
 
 .. note :: Email is used by the solution to send test reports and results.
 
-.. note :: It is possible to configure multiple email addresses for a user by separating them with ``; ``
+.. note :: It is possible to configure multiple email addresses for a user by separating them with ``;``
 
 Delete a user
 ----------------------

diff --git a/docs/developer/api.rst b/docs/developer/api.rst
@@ -85,28 +85,28 @@ Description of most important functions:
 
 **Authentication**
 
-+-------------------------+-----------------------------------------------------------------------------------------------------------------+
-|/rest/session/login      | `Details <https://demo.extensiveautomation.org/web/common-api-rest/index.html#api-Session-sessionLogin>`_          |
-+-------------------------+-----------------------------------------------------------------------------------------------------------------+
-|/rest/session/logout     | `Details <https://demo.extensiveautomation.org/web/common-api-rest/index.html#api-Session-sessionLogout>`_         |
-+-------------------------+-----------------------------------------------------------------------------------------------------------------+
++-------------------------+---------------------------------------------------------------------------------------------------------------+
+|/rest/session/login      | `Details <https://demo.extensiveautomation.org/web/common-api-rest/index.html#api-Session-sessionLogin>`_     |
++-------------------------+---------------------------------------------------------------------------------------------------------------+
+|/rest/session/logout     | `Details <https://demo.extensiveautomation.org/web/common-api-rest/index.html#api-Session-sessionLogout>`_    |
++-------------------------+---------------------------------------------------------------------------------------------------------------+
 
 **Execute a test**
 
 +-------------------------+-----------------------------------------------------------------------------------------------------------------+
-|/rest/tests/schedule     | `Details <https://demo.extensiveautomation.org/web/tester-api-rest/index.html#api-Tests-testsSchedule>`_           |
+|/rest/tests/schedule     | `Details <https://demo.extensiveautomation.org/web/tester-api-rest/index.html#api-Tests-testsSchedule>`_        |
 +-------------------------+-----------------------------------------------------------------------------------------------------------------+
-|/rest/tests/schedule/tpg | `Details <https://demo.extensiveautomation.org/web/tester-api-rest/index.html#api-Tests-testsScheduleTpg>`_        |
+|/rest/tests/schedule/tpg | `Details <https://demo.extensiveautomation.org/web/tester-api-rest/index.html#api-Tests-testsScheduleTpg>`_     |
 +-------------------------+-----------------------------------------------------------------------------------------------------------------+
 
 **Read the result of a test executed**
 
 +-------------------------+-----------------------------------------------------------------------------------------------------------------+
-|/rest/results/reports    | `Details <https://demo.extensiveautomation.org/web/tester-api-rest/index.html#api-Reports-resultsReports>`_        |
+|/rest/results/reports    | `Details <https://demo.extensiveautomation.org/web/tester-api-rest/index.html#api-Reports-resultsReports>`_     |
 +-------------------------+-----------------------------------------------------------------------------------------------------------------+
-|/rest/results/status     | `Details <https://demo.extensiveautomation.org/web/tester-api-rest/index.html#api-Results-resultsStatus>`_         |
+|/rest/results/status     | `Details <https://demo.extensiveautomation.org/web/tester-api-rest/index.html#api-Results-resultsStatus>`_      |
 +-------------------------+-----------------------------------------------------------------------------------------------------------------+
-|/rest/results/verdict    | `Details <https://demo.extensiveautomation.org/web/tester-api-rest/index.html#api-Results-resultsVerdict>`_        |
+|/rest/results/verdict    | `Details <https://demo.extensiveautomation.org/web/tester-api-rest/index.html#api-Results-resultsVerdict>`_     |
 +-------------------------+-----------------------------------------------------------------------------------------------------------------+
 
 

diff --git a/docs/developer/contributions.rst b/docs/developer/contributions.rst
@@ -17,7 +17,7 @@ To prepare its development environment, it is necessary to recover and install t
   - TortoiseGit-2.5.0.0-64bit.msi
   - InnoSetup 5.5.9 - http://www.jrsoftware.org/isdl.php
 
-Add additional Python packages with the `` pip`` command
+Add additional Python packages with the ``pip`` command
 
 .. code-block:: bash
 
@@ -33,7 +33,7 @@ And retrieve the sources of the client since the deposit on github.
     
 .. warning :: Windows XP is not supported in this mode.
 
-** x64 environment win py3.4 qt4 **
+**x64 environment win py3.4 qt4**
 
 .. warning :: This development environment is no longer recommended.
 

diff --git a/docs/developer/requirements.rst b/docs/developer/requirements.rst
@@ -20,7 +20,7 @@ Features                | Minimum      | Recommended  |
 +-----------------------+--------------+--------------+
 | CPU                   | 2 core       | 4 core       |
 +-----------------------+--------------+--------------+
-| Disk                  | ~ 10GB       | ~ 50GB       |
+| Disk                  | ~10GB        | ~50GB        |
 +-----------------------+--------------+--------------+
 | Network               | 100Mb/s      | 1 Gbit/s     |
 +-----------------------+--------------+--------------+
@@ -38,13 +38,13 @@ The client can be run on a Windows or Linux environment.
 | Features          | Minimum                     | Recommended                  |
 +-------------------+-----------------------------+------------------------------+
 | OS                | Windows 7+                  | Windows 10+                  |
-|                   | Linux CentOS 6.5+           | CentOS7 + or Ubuntu 17+      |
+|                   | Linux CentOS 6.5+           | CentOS7+ or Ubuntu 17+       |
 +-------------------+-----------------------------+------------------------------+
 | Arch              | x86_64                      |                              |
 +-------------------+-----------------------------+------------------------------+
 | Memory            | 4GB                         | 8GB                          |
 +-------------------+-----------------------------+------------------------------+
-| Disk              | ~ 1GB                       | ~ 2GB                        |
+| Disk              | ~1GB                        | ~2GB                         |
 +-------------------+-----------------------------+------------------------------+
 
 .. note::
@@ -63,13 +63,13 @@ The toolbox can be run on a Windows or Linux environment.
 Features            | Minimum                     | Recommended                  |
 +-------------------+-----------------------------+------------------------------+
 | OS                | Windows 7+                  | Windows 10+                  |
-|                   | Linux CentOS 6.5+           | CentOS7 + or Ubuntu 17+      |
+|                   | Linux CentOS 6.5+           | CentOS7+ or Ubuntu 17+       |
 +-------------------+-----------------------------+------------------------------+
 | Arch              | x86_64                      |                              |
 +-------------------+-----------------------------+------------------------------+
 | Memory            | 4GB                         | 8GB                          |
 +-------------------+-----------------------------+------------------------------+
-| Disk              | ~ 1GB                       |                              |
+| Disk              | ~1GB                        |                              |
 +-------------------+-----------------------------+------------------------------+
 
 .. note::