Review of documentation for 0.6

ltb-project · Dec 2, 2024 · bce30f2 · bce30f2
1 parent 473d90f
commit bce30f2
Show file tree

Hide file tree

Showing 25 changed files with 60 additions and 22 deletions.
diff --git a/docs/attributes.rst b/docs/attributes.rst
@@ -1,6 +1,9 @@
 Attributes
 ==========
 
+Attributes map
+--------------
+
 Attributes are defined in ``$attributes_map``, where each item is an array with these keys:
 
 * ``attribute``: name of LDAP attribute, in lower case

diff --git a/docs/audit.rst b/docs/audit.rst
@@ -60,7 +60,7 @@ Using Nginx, we could use instead:
 
 In nginx.conf:
 
-.. code-block:: nginx
+.. code-block::
 
   server {
           [...]
@@ -76,10 +76,10 @@ In nginx.conf:
 .. tip:: If no header defined or if header is empty, actions will be logged as "anonymous"
 
 Display audit logs
-==================
+------------------
 
 Enabling audit logs display
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 When the audit logs are enabled, they can be displayed in a table by setting the following variable:
 
@@ -88,7 +88,7 @@ When the audit logs are enabled, they can be displayed in a table by setting the
    $use_showauditlog = true;
 
 Days of audit logs
-------------------
+^^^^^^^^^^^^^^^^^^
 
 The number of days that can be displayed in the table can be configured as follows:
 
@@ -101,7 +101,7 @@ The number of days that can be displayed in the table can be configured as follo
    The log file specified under $audit_log_file may only contain logs generated within the last $audit_log_days due to log rotation configuration.
 
 Display table columns
----------------------
+^^^^^^^^^^^^^^^^^^^^^
 
 The table columns to be displayed can be configured with the following variable:
 
@@ -110,7 +110,7 @@ The table columns to be displayed can be configured with the following variable:
    $audit_log_items = array('date','ip','dn','done_by','action','result','comment');
 
 Audit table sorting
--------------------
+^^^^^^^^^^^^^^^^^^^
 
 The table can be sorted by default by the setting:
 
@@ -119,7 +119,7 @@ The table can be sorted by default by the setting:
    $audit_log_sortby = "date";
 
 Audit table sorting order
--------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Audit logs are usually display with the oldest first as they are being parsed from a file.
 In order to have the newest audit log entries first the following configuration can reverse the order:

diff --git a/docs/checkpassword.rst b/docs/checkpassword.rst
@@ -1,6 +1,8 @@
 Check password
 ==============
 
+.. image:: images/ltb_sd_check_password.png
+
 This feature allows to enter a password and check authentication.
 
 .. warning:: the authentification can fail even if the password is correct.

diff --git a/docs/conf.py b/docs/conf.py
@@ -59,7 +59,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/docs/configuration-nginx.rst b/docs/configuration-nginx.rst
@@ -1,14 +1,14 @@
 .. _nginx_configuration:
 
 Nginx configuration
-====================
+===================
 
 Apache or Nginx is not installed by default. You must choose one.
 
 Current section explains how to install and configure Nginx.
 
 Install and configure Nginx
-----------------------------
+---------------------------
 
 On Debian:
 
@@ -26,7 +26,7 @@ On RHEL systems:
   dnf install nginx
 
 Virtual host configuration
-------------
+--------------------------
 
 Here is a sample block server configuration:
 

diff --git a/docs/dashboards.rst b/docs/dashboards.rst
@@ -12,7 +12,7 @@ To enable it:
 
     $use_searchlocked = true;
 
-It is possible to unlock an account directly from this page. This requires to enable the feature :doc:`unlockaccount`.
+It is possible to unlock an account directly from this page. This requires to enable the feature :doc:`lockaccount`.
 
 Disabled accounts
 -----------------

diff --git a/docs/display-parameters.rst b/docs/display-parameters.rst
@@ -4,6 +4,8 @@ Display parameters
 User panel
 ----------
 
+.. image:: images/ltb_sd_user_panel.png
+
 Configure which items are displayed:
 
 .. code-block:: php
@@ -25,6 +27,8 @@ Choose to show undefined values:
 Account information panel
 -------------------------
 
+.. image:: images/ltb_sd_account_information.png
+
 Configure which items are displayed:
 
 .. code-block:: php
@@ -40,12 +44,25 @@ You can also display the password expiration date in this panel by enabling this
 Lock status
 -----------
 
+.. image:: images/ltb_sd_lock_status.png
+
 You can disable the lock status panel:
 
 .. code-block:: php
 
     $show_lockstatus = false;
 
+Enable status
+-------------
+
+.. image:: images/ltb_sd_enable_status.png
+
+You can disable the enable status panel:
+
+.. code-block:: php
+
+    $show_enablestatus = false;
+
 Expire status
 -------------
 
@@ -58,6 +75,8 @@ You can disable the expire status panel:
 Validity status
 ---------------
 
+.. image:: images/ltb_sd_validity_status.png
+
 You can disable the validity status panel:
 
 .. code-block:: php

diff --git a/docs/enableaccount.rst b/docs/enableaccount.rst
@@ -1,6 +1,8 @@
 Enable and disable account
 ==========================
 
+.. image:: images/ltb_sd_enable_status.png
+
 Show enabled status
 -------------------
 

diff --git a/docs/general-parameters.rst b/docs/general-parameters.rst
@@ -24,7 +24,7 @@ Multi tenancy
 You can load a specific configuration file by passing a HTTP header.
 This feature is disable by default. To enable it:
 
-.. code:: php
+.. code-block:: php
 
    $header_name_extra_config = "SSP-Extra-Config";
 
@@ -33,7 +33,7 @@ Then if you send the header ``SSP-Extra-Config: domain1``, the file
 
 Using Apache, we may set such header using the following:
 
-.. code:: apache
+.. code-block::
 
     <VirtualHost *:80>
        ServerName ssp.domain1.com
@@ -43,7 +43,7 @@ Using Apache, we may set such header using the following:
 
 Using Nginx, we could use instead:
 
-.. code:: nginx
+.. code-block::
 
    server {
        [...]
@@ -187,14 +187,14 @@ It is possible to provide mail of administrator to service-desk using a HTTP hea
 
 $header_name_notify_admin_by_mail is name of header that will be provided to cgi script as HTTP_$header_name_notify_admin_by_mail to set administrator mail from webserver.
 
-.. code:: php
+.. code-block:: php
 
    $header_name_notify_admin_by_mail = "SSP-Admin-Mail";
 
 
 Using Apache, we may set such header using the following:
 
-.. code:: apache
+.. code-block::
 
     <VirtualHost *:80>
        ServerName ssp.domain1.com
@@ -205,7 +205,7 @@ Using Apache, we may set such header using the following:
 Using Nginx, nginx take normalized cgi param naming, ie uppercase and - replaced to _.
 we could use instead:
 
-.. code:: nginx
+.. code-block::
 
    server {
        [...]

diff --git a/docs/images/ltb_sd_0.6.png b/docs/images/ltb_sd_0.6.png
diff --git a/docs/images/ltb_sd_account_information.png b/docs/images/ltb_sd_account_information.png
diff --git a/docs/images/ltb_sd_check_password.png b/docs/images/ltb_sd_check_password.png
diff --git a/docs/images/ltb_sd_comment.png b/docs/images/ltb_sd_comment.png
diff --git a/docs/images/ltb_sd_enable_status.png b/docs/images/ltb_sd_enable_status.png
diff --git a/docs/images/ltb_sd_lock_status.png b/docs/images/ltb_sd_lock_status.png
diff --git a/docs/images/ltb_sd_reset_password.png b/docs/images/ltb_sd_reset_password.png
diff --git a/docs/images/ltb_sd_search.png b/docs/images/ltb_sd_search.png
diff --git a/docs/images/ltb_sd_user_panel.png b/docs/images/ltb_sd_user_panel.png
diff --git a/docs/images/ltb_sd_validity_status.png b/docs/images/ltb_sd_validity_status.png
diff --git a/docs/images/ltb_sd_welcome_page.png b/docs/images/ltb_sd_welcome_page.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,11 +6,11 @@
 LDAP Tool Box Service Desk documentation
 ========================================
 
-.. image:: images/ltb_sd_screenshot.jpg
+.. image:: images/ltb_sd_0.6.png
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
+   :caption: Contents
 
    presentation.rst
    installation.rst

diff --git a/docs/lockaccount.rst b/docs/lockaccount.rst
@@ -1,6 +1,8 @@
 Lock and unlock account
 =======================
 
+.. image:: images/ltb_sd_lock_status.png
+
 Show lock status
 ----------------
 

diff --git a/docs/presentation.rst b/docs/presentation.rst
@@ -1,6 +1,8 @@
 Presentation
 ============
 
+.. image:: images/ltb_sd_welcome_page.png
+
 LDAP Tool Box Service Desk is a web application for administrators and support teams.
 It allows to browse accounts in an LDAP directory, view and update their status.
 
@@ -31,3 +33,7 @@ Features
   * Accounts with an expired password
   * Accounts idle (never connected or not connected since a number of days)
   * Accounts invalid (for which start date is in the future, or end date is in the past)
+
+.. image:: images/ltb_sd_search.png
+
+.. image:: images/ltb_sd_comment.png
diff --git a/docs/resetpassword.rst b/docs/resetpassword.rst
@@ -1,6 +1,8 @@
 Reset password
 ==============
 
+.. image:: images/ltb_sd_reset_password.png
+
 This feature allows to reset a password and set the reset at next connection flag.
 
 To enable this feature:

diff --git a/docs/updatestartendtime.rst b/docs/updatestartendtime.rst
@@ -1,14 +1,16 @@
 Update start and end validity dates
 ===================================
 
+.. image:: images/ltb_sd_validity_status.png
+
 Some LDAP directories provide attributes to define start and end account validify dates.
 
 For OpenLDAP since 2.5 version, attributes are ``pwdStartTime`` and ``pwdEndTime``.
 
 For Active Directory, only end time is available, in ``accountExpires`` attribute.
 
 Show validity status
--------------------
+--------------------
 
 Service Desk will display if account is valid or not. To allow this feature:
 
@@ -28,7 +30,7 @@ To enable this feature:
     $use_updatestarttime = true;
 
 Update end date
------------------
+---------------
 
 This feature allows to edit the account end validity date. This requires to have the `endtime` field defined in the attributes map.