From 480814ae306f36cff763c7a32de63d155331c853 Mon Sep 17 00:00:00 2001 From: Thomas Georgios Giannos Date: Tue, 23 Apr 2024 11:49:02 +0300 Subject: [PATCH] Docs for managing notification templates, supportive material and languages --- .../administration/introduction.md | 1 + .../documentation/administration/languages.md | 52 +++++++++++- .../administration/notification-templates.md | 79 ++++++++++++++++++- .../administration/supportive-material.md | 37 ++++++++- .../documentation/administration/tenants.md | 1 + .../documentation/administration/users.md | 1 + 6 files changed, 168 insertions(+), 3 deletions(-) diff --git a/docs/docs/documentation/administration/introduction.md b/docs/docs/documentation/administration/introduction.md index fd12980e6..42500b30c 100644 --- a/docs/docs/documentation/administration/introduction.md +++ b/docs/docs/documentation/administration/introduction.md @@ -1,5 +1,6 @@ --- sidebar_position: 1 +description: Discover all the configuration options available for an administrator --- # Introduction diff --git a/docs/docs/documentation/administration/languages.md b/docs/docs/documentation/administration/languages.md index c1b395290..76e644cd5 100644 --- a/docs/docs/documentation/administration/languages.md +++ b/docs/docs/documentation/administration/languages.md @@ -1,5 +1,55 @@ --- sidebar_position: 8 +description: Manage all available languages --- -# Languages \ No newline at end of file +# Languages + +In this page, there is a listing where you can view details about all the supported languages. + +The information displayed by default is: the `code` of the languages, the `status` and timestamps for the `creation` and `updates` of the records. At the top right corner of the listing you can also select which columns to display. + +:::tip + +For languages, all the columns are visible by default. + +::: + +You can add support for a new language by clicking to the `+ Create Language` button at the top right corner of the page. + +Editing and removing existing languages is also possible by clicking on the tree dots available on the last column. + +## Authorization + +Only users that have the **Admin** role can access this page. + +## Pagination + +Not all the records are being displayed at once. By default, there is a pagination of 10 records applied to them. + +You can control how many records are being displayed at any time, by adjusting the `items per page` control at the bottom left corner of the table. + +## Filtering + +There is a filtering option available for languages. + +- **Is Active**: By toggling this control you can view only the active or only the disabled languages.
*By default, this option is set to true.* + +In order for the filters to apply, you have to click the `Apply filters` button. + +You can also clear any filters already applied, by pressing the `clear all filters` option, located at the top of the popup. + +## Edit form + +When you try to add new languages or edit existing ones, the **language editing form** will appear containing the following controls: + +- **Code**: The code of the language, typically consisting of two characters.
*For example: 'en', 'pt' etc.* +- **Ordinal**: This controlls the position in which the language will appear on all the dropdowns with the available languages. +- **Payload**: Here all the language strings can be edited, in **JSON** format. +- **Override from file**: In case a language is already defined in a file format, you can load the contents of the definition on the `Payload` control by clicking this checkbox. Then, you can proceed to make any change you want on the payload. + +:::warning + +Editing a language payload will override the file definition, if it exists. + +::: \ No newline at end of file diff --git a/docs/docs/documentation/administration/notification-templates.md b/docs/docs/documentation/administration/notification-templates.md index 396392192..e342f6b61 100644 --- a/docs/docs/documentation/administration/notification-templates.md +++ b/docs/docs/documentation/administration/notification-templates.md @@ -1,5 +1,82 @@ --- sidebar_position: 10 +description: Manage all notification templates --- -# Notification Templates \ No newline at end of file +# Notification Templates + +In this page, there is a listing where you can view details about all the notification templates. + +The information displayed by default is: the `type` of the notifications, the `status`, the `precedence (kind)`, the notification `channel` to which it applies and timestamps for the `creation` and `updates` of the records. At the top right corner of the listing you can also select which columns to display. + +:::tip + +For notification templates, all the columns are visible by default. + +::: + +You can also create new or edit / remove notification templates by clicking to the `+ Create Notification Template` button at the top right corner of the page or to the three dots at the last column, respectively. + +## Authorization + +Only users that have the **Admin** role can access this page. + +## Pagination + +Not all the records are being displayed at once. By default, there is a pagination of 10 records applied to them. + +You can control how many records are being displayed at any time, by adjusting the `items per page` control at the bottom left corner of the table. + +## Filtering + +There is a filtering option available for tenants. + +- **Is Active**: By toggling this control you can view only the active or only the disabled notification templates.
*By default, this option is set to true.* +- **Type**: You can filter templates by the type which infers to the event this notification template applies to.
*By default, no type is selected.* +- **Kind**: You can filter templates by their precedence.
*By default, no kind is selected.* +- **Channel**: You can filter templates by the channel they are used in.
*By default, no channel is selected.* + +:::note + +More details about some of the above options are discussed in the editing form section below. + +::: + +In order for the filters to apply, you have to click the `Apply filters` button. + +You can also clear any filters already applied, by pressing the `clear all filters` option, located at the top of the popup. + +## Edit form + +When you try to add new notification templates or edit existing ones, the **notification template editing form** will appear containing the following controls: + +### Main information section + +- **Notification Type**: The notification type this template applies to. +- **Language**: The language of the template. +- **Kind**: The precedence of this template .A kind can either be `Draft`, `Primary`, `Secondary` or `Default`. +- **Channel**: The notification channel this template will be used. The channel can be either `Email` or `InApp`. + +### Subject section + +For the subject, we can specify the following: + +- **Subject Text**: The subject itself. +- **Subject Key**: The key referring to the subject on the template. + +### Body section + +For the body, we can specify the following: + +- **Body Text**: The actual contents of the template. +- **Body Key**: The key referring to the body on the template. + +### Extra options section + +- **Allow Attachments**: When checked, the notification can have attachments.
*By default, this option is set to false.* +- **Priority Key** +- **CC** +- **CC Mode**: It can either be `Not Override`,`Additive` or `Replace`. +- **BCC** +- **BCC Mode**: It can either be `Not Override`,`Additive` or `Replace`. +- **Extra Data Keys** \ No newline at end of file diff --git a/docs/docs/documentation/administration/supportive-material.md b/docs/docs/documentation/administration/supportive-material.md index f315e300c..2d04bbf3f 100644 --- a/docs/docs/documentation/administration/supportive-material.md +++ b/docs/docs/documentation/administration/supportive-material.md @@ -1,5 +1,40 @@ --- sidebar_position: 9 +description: Manage supportive material --- -# Supportive Material \ No newline at end of file +# Supportive Material + +In this page, you can view details about all the supportive material available to users directly on the platform. + +At the start, there are two controls available: + +- **Material Type**: You select the specific supportive material you want to edit. +- **Language**: These materials can have translations available for all the registered [languages](./languages.md). + +When you select both options above, the **supportive material editor** is opening. When you are done, you can save your changes by pressing the `save` button located at the bottom right corner of the screen. + +## Authorization + +Only users that have the **Admin** role can access this page. + +## Types of material + +Let's explore all the available supportive material types: + +- **FAQ**: Frequently Asked Questions. +- **About**: A brief description of the platform. +- **Glossary**: A brief description of the most important keywords you see through the app. +- **Terms Of Service** +- **User Guide**: A small guide available to the users directly on the platform + +:::note + +All the above are available for the users to read, following the links situated at the bottom part of the side navigation, visible on every page. + +::: +:::tip + +You can always minimize the navigation sidebar by clicking on the `x` button on the top of it. + +::: \ No newline at end of file diff --git a/docs/docs/documentation/administration/tenants.md b/docs/docs/documentation/administration/tenants.md index 52ad512bd..f59c187f0 100644 --- a/docs/docs/documentation/administration/tenants.md +++ b/docs/docs/documentation/administration/tenants.md @@ -1,5 +1,6 @@ --- sidebar_position: 7 +description: Manage all available tenants --- # Tenants diff --git a/docs/docs/documentation/administration/users.md b/docs/docs/documentation/administration/users.md index e2c1d82e8..816ef213d 100644 --- a/docs/docs/documentation/administration/users.md +++ b/docs/docs/documentation/administration/users.md @@ -1,5 +1,6 @@ --- sidebar_position: 6 +description: Manage all available users --- # Users