add faq on articles and structure of webhooks (#100)

Otijom · cconard96 · web-flow · commit f67924234fb3 · 2024-02-14T08:34:09.000+01:00
* add faq on articles and structure of webhooks

* add faq on more satisfaction

* add traduction webhook

* Update source/GDPR/index.rst

Co-authored-by: Curtis Conard &lt;cconard96@gmail.com&gt;

* Update source/webhook/rocket.rst

Co-authored-by: Curtis Conard &lt;cconard96@gmail.com&gt;

* modify faq to FAQ

* modify faq to FAQ

---------

Co-authored-by: Curtis Conard &lt;cconard96@gmail.com&gt;
diff --git a/.tx/config b/.tx/config
@@ -243,6 +243,60 @@ source_file = build/locale/webhook/index.pot
 source_lang = en
 type = PO
 
+[o:teclib:p:glpi-plugins-documentation:r:webhook--activate_webhooks]
+file_filter = source/locale/<lang>/LC_MESSAGES/webhook/activate_webhooks.po
+source_file = build/locale/webhook/activate_webhooks.pot
+source_lang = en
+type = PO
+
+[o:teclib:p:glpi-plugins-documentation:r:webhook--faq]
+file_filter = source/locale/<lang>/LC_MESSAGES/webhook/faq.po
+source_file = build/locale/webhook/faq.pot
+source_lang = en
+type = PO
+
+[o:teclib:p:glpi-plugins-documentation:r:webhook--install_plugin]
+file_filter = source/locale/<lang>/LC_MESSAGES/webhook/install_plugin.po
+source_file = build/locale/webhook/install_plugin.pot
+source_lang = en
+type = PO
+
+[o:teclib:p:glpi-plugins-documentation:r:webhook--mattermost]
+file_filter = source/locale/<lang>/LC_MESSAGES/webhook/mattermost.po
+source_file = build/locale/webhook/mattermost.pot
+source_lang = en
+type = PO
+
+[o:teclib:p:glpi-plugins-documentation:r:webhook--rocket]
+file_filter = source/locale/<lang>/LC_MESSAGES/webhook/rocket.po
+source_file = build/locale/webhook/rocket.pot
+source_lang = en
+type = PO
+
+[o:teclib:p:glpi-plugins-documentation:r:webhook--setup_glpi]
+file_filter = source/locale/<lang>/LC_MESSAGES/webhook/setup_glpi.po
+source_file = build/locale/webhook/setup_glpi.pot
+source_lang = en
+type = PO
+
+[o:teclib:p:glpi-plugins-documentation:r:webhook--slack]
+file_filter = source/locale/<lang>/LC_MESSAGES/webhook/slack.po
+source_file = build/locale/webhook/slack.pot
+source_lang = en
+type = PO
+
+[o:teclib:p:glpi-plugins-documentation:r:webhook--teams]
+file_filter = source/locale/<lang>/LC_MESSAGES/webhook/teams.po
+source_file = build/locale/webhook/teams.pot
+source_lang = en
+type = PO
+
+[o:teclib:p:glpi-plugins-documentation:r:webhook--telegram]
+file_filter = source/locale/<lang>/LC_MESSAGES/webhook/telegram.po
+source_file = build/locale/webhook/telegram.pot
+source_lang = en
+type = PO
+
 [o:teclib:p:glpi-plugins-documentation:r:splitcat--index]
 file_filter = source/locale/<lang>/LC_MESSAGES/splitcat/index.po
 source_file = build/locale/splitcat/index.pot
diff --git a/source/GDPR/index.rst b/source/GDPR/index.rst
@@ -85,3 +85,7 @@ Deletion will take place via a standard GLPI automatic action that can be config
    :scale: 65 %
 
 
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/GDRP/>`__
diff --git a/source/advanceddashboard/index.rst b/source/advanceddashboard/index.rst
@@ -141,3 +141,7 @@ Dashboard settings
    :scale: 100 %
 
 
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Advanced_dashboard/>`__
diff --git a/source/anonymize/index.rst b/source/anonymize/index.rst
@@ -1410,3 +1410,8 @@ Ticket templates
     - `name`
     - `entities_id`
     - `comment`
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Anonymize/>`__
diff --git a/source/approbalbymail/index.rst b/source/approbalbymail/index.rst
@@ -61,4 +61,9 @@ An email will be received with the option of **Validating** or **Refusing** the
 
 .. figure:: images/Approval_mail-6.png
    :alt: refused
-   :scale: 100 %
+   :scale: 100 %
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Approval_mail/>`__
diff --git a/source/branding/index.rst b/source/branding/index.rst
@@ -81,3 +81,9 @@ Default recommended size: **220x130 pixels**
    at the login page.
 
 Default recommended size: **It depends on the usual size of your screens**. The bigger, the better. (Make sure not to surpass the maximum upload limit for files)
+
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Branding/>`__
diff --git a/source/credit/index.rst b/source/credit/index.rst
@@ -190,4 +190,7 @@ An automatic action is available to notify you when a credit has expired.
 You can of course customise the notification to suit your needs (**Setup > Notifications > Notifications > credit expired**)
 
 
+FAQ
+---
 
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Cr%C3%A9dit/>`__
diff --git a/source/datainjection/index.rst b/source/datainjection/index.rst
@@ -206,3 +206,7 @@ Once the progress bar is full, click on **Finish**
    :scale: 45 %
 
 
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Data_injection/>`__
diff --git a/source/escalade/index.rst b/source/escalade/index.rst
@@ -215,3 +215,8 @@ New dashlet to display not solved ticket where your groups was not actually assi
 .. image:: images/central_follow.png
    :alt:
    :scale: 90 %
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Escalade/>`__
diff --git a/source/fields/index.rst b/source/fields/index.rst
@@ -208,3 +208,8 @@ A            Yes or No       B           No
 A            Yes             C           Yes
 A            No              C           No
 ============ =============== =========== ===============
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Fields/>`__
diff --git a/source/genericobject/index.rst b/source/genericobject/index.rst
@@ -544,7 +544,7 @@ Define Admin_biomed profile
 
 1. Clone *Admin* profile
 2. Set following rights in *Admin_biomed* profile :
-   
+
    * *Administration > Profiles > Admin_biomed > Assets tab > Unselect all*
    * *Administration > Profiles > Admin_biomed > Assistance tab > Association > Associable items to a ticket > Biomedical*
    * *Administration > Profiles > Admin_biomed > Management tab > Select all*
@@ -567,3 +567,8 @@ Start using Generic Object and GLPI
 As *Admin_biomed* user, you can create your first object in *Assets > Biomedical*.
 
 In order to gain time, define values in *Setup > Dropdowns > Objects management* for new fields.
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Generic_objects/>`__
diff --git a/source/holidays/index.rst b/source/holidays/index.rst
@@ -58,3 +58,8 @@ Easter Monday is not a day off.
    :alt: mass removal
    :scale: 45 %
 
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Holiday/>`__
+
diff --git a/source/moresatisfaction/index.rst b/source/moresatisfaction/index.rst
@@ -158,5 +158,8 @@ Survey reminders are sent via an automatic action already created by the plugin.
    :alt: automatic action
    :scale: 70 %
 
+FAQ
+---
 
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Satisfaction_survey/>`__
 
diff --git a/source/news/index.rst b/source/news/index.rst
@@ -90,3 +90,9 @@ Display on helpdesk page
 
 .. image:: images/helpdesk-page.png
    :scale: 40 %
+
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/News/>`__
diff --git a/source/oauthimap/index.rst b/source/oauthimap/index.rst
@@ -121,3 +121,7 @@ Setup GLPI
    :alt: check account
    :scale: 80 %
 
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/OAuth_IMAP/>`__
diff --git a/source/oauthsso/source.rst b/source/oauthsso/source.rst
@@ -4,4 +4,9 @@ Sources link
 - `Documentation Oauth SSO client for GLPI <https://services.glpi-network.com/documentation/1731/file/README.md>`__
 - `Documentation Microsoft Configure your App Service Or Entra Functions app to use Entra AD login <https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-provider-aad?tabs=workforce-tenant>`__
 - `Documentation OKTA Configure single Sign-On options <https://help.okta.com/oie/en-us/content/topics/apps/apps_overview_of_managing_apps_and_sso.htm>`__
-- `Documentation Keycloak Managing OpenID connect Clients <https://www.keycloak.org/docs/latest/server_admin/#_oidc_clients>`__
+- `Documentation Keycloak Managing OpenID connect Clients <https://www.keycloak.org/docs/latest/server_admin/#_oidc_clients>`__
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Authentication_and_SSO/>`__
diff --git a/source/order/index.rst b/source/order/index.rst
@@ -293,3 +293,8 @@ The plugin rights management allows to define, by profile, if the user has the r
 * Confirm an order
 * Cancel an order
 * Modify a validated order
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Order/>`__
diff --git a/source/renamestrings/index.rst b/source/renamestrings/index.rst
@@ -57,3 +57,7 @@ After :
    :alt: after
    :scale: 100 %
 
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Rename_strings/>`__
diff --git a/source/scim/index.rst b/source/scim/index.rst
@@ -79,3 +79,9 @@ Although it’s mentioned in the `SCIM specifications <https://datatracker.ietf.
 
 -  Azure: `not available <https://learn.microsoft.com/en-us/answers/questions/1113754/azure-ad-scim-provisioning-how-to-sync-passwords>`__
 -  Okta: `available <https://developer.okta.com/docs/concepts/scim/#sync-passwords>`__
+
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/SCIM/>`__
diff --git a/source/splitcat/index.rst b/source/splitcat/index.rst
@@ -42,3 +42,8 @@ After
 .. figure:: images/Splitcat-3.gif
    :alt: after
    :scale: 100 %
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Splitcat/>`__
diff --git a/source/tag/index.rst b/source/tag/index.rst
@@ -99,3 +99,7 @@ Example : Assign a VIP tag when a member of the management group writes a ticket
     Tags can, of course, be added manually if they have been set to be visible in the specified item.
 
 
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Tags/>`__
diff --git a/source/translate/index.rst b/source/translate/index.rst
@@ -261,4 +261,9 @@ This right defines whether a profile can translate timeline elements of a ticket
 Allow translation while writing
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-This right defines whether a profile can translate the content of a follow-up before sending.
+This right defines whether a profile can translate the content of a follow-up before sending.
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Translate/>`__
diff --git a/source/uninstall/index.rst b/source/uninstall/index.rst
@@ -209,4 +209,9 @@ This selection is made either :
 * in the equipment sheet, once the replacement model has been chosen,
 * from the user's preferences for massive modification replacement.
 
-Note that a location is declared within an entity. It is therefore possible, depending on the current entity, to define a replacement location.
+Note that a location is declared within an entity. It is therefore possible, depending on the current entity, to define a replacement location.
+
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Uninstall/>`__
diff --git a/source/unread/index.rst b/source/unread/index.rst
@@ -96,3 +96,7 @@ Management by entity is possible to manage the counting of notifications by enti
    :alt: by entity
    :scale: 60 %
 
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Unread/>`__
diff --git a/source/webhook/activate_webhooks.rst b/source/webhook/activate_webhooks.rst
@@ -0,0 +1,8 @@
+Activate webhooks
+-----------------
+
+-  In the tab **Setup > Notifications** activate Webhooks notifications
+
+.. figure:: images/Webhook-2.png
+   :alt: activate webhooks
+   :scale: 100 %
diff --git a/source/webhook/faq.rst b/source/webhook/faq.rst
@@ -0,0 +1,4 @@
+FAQ
+---
+
+If you have any questions about using the plugin, please consult `our FAQ <https://faq.teclib.com/04_Plugins/Collaborative_tools/>`__
diff --git a/source/webhook/index.rst b/source/webhook/index.rst
diff --git a/source/webhook/install_plugin.rst b/source/webhook/install_plugin.rst
diff --git a/source/webhook/mattermost.rst b/source/webhook/mattermost.rst
diff --git a/source/webhook/rocket.rst b/source/webhook/rocket.rst
diff --git a/source/webhook/setup_glpi.rst b/source/webhook/setup_glpi.rst
diff --git a/source/webhook/slack.rst b/source/webhook/slack.rst
diff --git a/source/webhook/teams.rst b/source/webhook/teams.rst
diff --git a/source/webhook/telegram.rst b/source/webhook/telegram.rst
