Merge pull request #112 from codevence/preview

Release/4.13

docs/about/introduction/knowledge-model.rst

@@ -80,6 +80,7 @@ The value question asks for a single value that users type in. There are many di
 
 The input field differs based on the value type (simple input for string, date picker for date, etc.). Some of these have a check whether the entered value is valid (such as valid email or URL) and displays a warning if not.
 
+Value Question also can have validations. Validations differ based on the value type. For example, we can set a minimum and maximum value for a number, or a minimum and maximum length for a string. For text based types (text, email, URL), we can set also use a regular expression to create validations.
 
 .. _integration-question:
 
@@ -138,6 +139,12 @@ Choice
 
 A choice is used with :ref:`multi-choice questions<multi-choice-question>`. It only contains a **label** which is presented to the user.
 
+.. _validation:
+
+Validation
+----------
+
+Validation is used to define some rules for the answers in Value question type. It can be used to check if the answer is in the correct format, or if it is in the correct range. If the answer doesn't pass the validation, a warning is displayed to the user, however this does not prevent them from creating a document.
 
 .. _reference:
 

docs/applications/admin-center/automations/index.rst

@@ -9,17 +9,19 @@ Automations
 
 Automations are customizable pieces of code that adjust the behavior of FAIR Wizard when certain events occur. Currently, automations support events when user logs in via Single Sing On (OpenID or SAML).
 
-.. TODO::
+.. figure:: automations/list.png
+
+    List of Automations with possible actions.
 
-    Add list screenshot
 
 The Automations use the Integration SDK to create and manage automations. The SDK provides a set of classes and methods that allow you to create and manage automations. The SDK is available in the FAIR Wizard application and can be accessed by going to the Open ID or SAML Settings. The SDK has its own `documentation <https://integration-sdk.fair-wizard.com/en/latest/>`__.
 
 From Automations list we can open specific automations or delete them. To create a new automation, go either to :doc:`../settings/authentication/openid` or :doc:`../settings/authentication/saml`.
 
-.. TODO::
+.. figure:: automations/openid-configuration.png
+
+    Example of Open ID Automation configuration.
 
-    Add Automation detail screenshot
 
 Example of OpenID Automation to check if an user should be able to login:
 
@@ -51,3 +53,21 @@ Example of OpenID Automation to check if an user should be able to login:
             email=email,
             user_group_uuids=groups,
         )
+
+.. figure:: automations/openid-logs.png
+
+    Each run of an Automation is logged.
+
+
+Similarly we can set up an Automation for SAML login.
+
+.. figure:: automations/saml-configuration.png
+
+    Example of SAML Automation configuration.
+
+
+.. figure:: automations/saml-logs.png
+
+    Each run of an Automation is logged.
+
+

docs/applications/admin-center/settings/authentication/openid.rst

@@ -10,25 +10,24 @@ Using these settings we can add `Open ID <https://openid.net/>`__ configuration
 *  Configure the client to provide the following details in ID tokens: ``email``, ``given_name``, ``family_name``
 
 Back in the |project_name| settings, we can fill **Client ID**, **Client Secret**, and **URL** from our OpenID client together with optional **Parameters** (usually not needed). Finally, we can configure how the log-in button will look like by setting **Icon** (by using `Font Awesome <https://fontawesome.com/v6/search?o=r&m=free>`_), **Name**, **Background**, and text/icon **Color**.
-
-.. NOTE::
-
-    After setting a new OpenID service, we should directly test it and verify that the configuration works well. For that, we can simply open our |project_name| instance in a new anonymous window of the web browser.
 
 .. figure:: openid/openid.png
     :width: 700
 
     Example configuration of OpenID service.
 
-.. TODO::
 
-    Update above screenshot, there is now Add automation button
+.. NOTE::
 
-We can use the **Add automation** button to add some extra steps after users use this login option. There are two tabs. Configuration, where we can set up automation using the `Integration SDK <https://integration-sdk.fair-wizard.com/en/latest/>`__ and Logs where we can see logs of the automation. The automation can have its name changed and it can be enabled or disabled.
+    After setting a new OpenID service, we should directly test it and verify that the configuration works well. For that, we can simply open our |project_name| instance in a new anonymous window of the web browser.
+
+We can use the **Create automation** button to add some extra steps after users use this login option. There are two tabs. Configuration, where we can set up automation using the `Integration SDK <https://integration-sdk.fair-wizard.com/en/latest/>`__ and Logs where we can see logs of the automation. The automation can have its name changed and it can be enabled or disabled. See details in :ref:`automations`.
 
-.. TODO::
+.. figure:: openid/openid-detail.png
+    :width: 700
+
+    Configured OpenID service (with hidden details).
 
-    Add Automation Configuration screenshot
 
 .. NOTE::
 

docs/applications/admin-center/settings/authentication/saml.rst

@@ -14,15 +14,14 @@ Based on SAML, FAIR Wizard supports authentication using `Shibboleth <https://ww
 
     Example configuration of SAML service.
 
-.. TODO::
 
-    Update above screenshot, there is now Add automation button
+We can use the **Create automation** button to add some extra steps after users use this login option. There are two tabs. Configuration, where we can set up automation using the `Integration SDK <https://integration-sdk.fair-wizard.com/en/latest/>`__ and Logs where we can see logs of the automation. The automation can have its name changed and it can be enabled or disabled. See details in :ref:`automations`.
 
-We can use the **Add automation** button to add some extra steps after users use this login option. There are two tabs. Configuration, where we can set up automation using the `Integration SDK <https://integration-sdk.fair-wizard.com/en/latest/>`__ and Logs where we can see logs of the automation. The automation can have its name changed and it can be enabled or disabled.
-
-.. TODO::
+.. figure:: saml/saml-detail.png
+    :width: 700
+
+    Configured SAML service (with hidden details).
 
-    Add Automation Configuration screenshot
 
 .. NOTE::
 

docs/applications/admin-center/settings/system/ai-assistant.rst

@@ -0,0 +1,21 @@
+AI Assistant
+************
+
+AI Assistant is FAIR Wizard wide feature that allows you to interact with the AI Assistant. The AI Assistant is a chatbot that can help you with various tasks in FAIR Wizard. You can ask the AI Assistant questions about FAIR Wizard, and it will provide you with the information you need. The AI Assistant can also provide knowledge regarding tasks such as creating a new project, creating knowledge models or document templates, and more.
+
+The AI Assistant is available in the bottom left corner of the screen. The AI Assistant will appear on the right side, where you can interact with it.
+
+.. figure:: ai-assistant/ai-assistant.png
+
+    AI Assistant.
+
+
+The AI Assistant does not have access to any FAIR Wizard data. Its knowledge is based on the information available in this FAIR Wizard documentation. The AI Assistant is designed to help you navigate FAIR Wizard and provide you with the information you need to complete your tasks.
+
+The AI Assistant can be turned off in the settings.
+
+.. figure:: ai-assistant/settings.png
+    :width: 700
+
+    AI Assistant settings.
+

docs/applications/admin-center/settings/system/index.rst

@@ -13,5 +13,6 @@ System settings allow us to configure Privacy and Support settings of |project_n
 .. toctree::
     :maxdepth: 2
 
-    Privacy and Support<privacy-and-support>
+    Support<support>
     Users<users>
+    AI Assistant<ai-assistant>

docs/applications/admin-center/settings/system/support.rst

@@ -0,0 +1,14 @@
+Support Settings
+****************
+
+These settings also allow us to configure **Support Email** that users can use to request help or report issues. Similarly **Support Site Name** and **Support Site URL** can be used in case we want users to create tickets in issue tracker of some repository, e.g., on GitHub. **Support Site Icon** can also be configured, using `Font Awesome <https://fontawesome.com/v6/search?o=r&m=free>`_. These support links together with an icon are then shown in :guilabel:`Report issue` modal window.
+
+.. NOTE::
+
+    Terms of Service and Privacy Policy can no longer be customized. If you require custom Terms of Service or Privacy Policy, please contact the `FAIR Wizard support <mailto:[email protected]>`_.
+
+
+.. figure:: support/support.png
+    :width: 700
+
+    Support settings.

docs/applications/data-management-planner/document-templates/editors/detail/files.rst

@@ -5,7 +5,9 @@ The :guilabel:`Files` tab in :doc:`./index` allows us to manage the files and di
 
 If we select a text file in the file tree, it is opened in the built-in text editor. We can also open multiple files (the editor supports tabs). Moreover, if we have more files opened, we can see a *split view* icon on the top of the file tree. When we click it, it will split the view and move the opened file to the other group. If there are already two groups, it switches the file between the two groups. We can close the file by clicking cross icon in its tab.
 
-We can easily delete a file or a folder; when it is selected in the file tree, we can simply click the red trash icon above the file tree. The deletion must be confirmed in the prompt so we will not delete something by accident as it is not reversible operation.
+We can easily delete files; when it is selected in the file tree, we can simply click the red trash icon above the file tree. The deletion must be confirmed in the prompt so we will not delete something by accident as it is not reversible operation. To delete folder, we must first delete all files and folders in it. Then it disappears from the file tree.
+
+With files and folders we can also use move and rename functionalities, both by clicking their respective icons above the file tree. The move functionality is useful when we want to move a file to another folder. The rename functionality is useful when we want to change the name of a file or folder.
 
 If we make some changes in a file, the asterisk (or star) symbol will appear by the name in the tree view as well as in the tab (if opened). The changes must be then saved using :guilabel:`Save` button or discarded using :guilabel:`Discard` button in the top right corner. Those buttons will appear instead of :guilabel:`Publish` as it is not possible to publish a document template with unsaved changes. After saving the changes and switching to :doc:`./preview` (or refreshing it), the document will be re-generated using the newly changed document template.
 

docs/applications/data-management-planner/document-templates/list/detail.rst

@@ -5,7 +5,7 @@ We can check a document template detail by clicking on a desired template in the
 
 The main part of the detail is the README of the template that should contain basic information and changelog for the template. In the right panel under the basic information, we can navigate to other versions of the document template, navigate to the `FAIR Wizard Registry <https://registry.fair-wizard.com/>`__ (if the template is present there), or check compatible knowledge model with the template.
 
-In the top bar, we can :guilabel:`Export` the template as a ZIP package or :guilabel:`Delete` this version of the template (only if it is not already used for some documents). We can also quickly navigate to :doc:`../editors/create` by clicking :guilabel:`Create editor`; it will prepare editor creation for a new version of this document template. Finally, there is the possibility :guilabel:`Set deprecated` which will change the state of the document template so it is no longer usable by researchers in their projects (it becomes unavailable).
+In the top bar, we can :guilabel:`Export` the template as a ZIP package or :guilabel:`Delete` this version of the template (only if it is not already used for some documents). We can also quickly navigate to :doc:`../editors/create` by clicking :guilabel:`Create editor`; it will prepare editor creation for a new version of this document template. Finally, there is the possibility :guilabel:`Set deprecated` which will change the state of the document template so it is no longer usable by researchers in their projects (it becomes unavailable). This only applies to the latest version of the document template. If there is an older version, that will still be available.
 
 If we are not seeing the latest version of the template, a warning message is shown in the top. Similarly, we will see a notification that update is available if there is a newer version in the `FAIR Wizard Registry <https://registry.fair-wizard.com/>`__ (if configured).
 

docs/applications/data-management-planner/knowledge-models/editors/detail/knowledge-model.rst

@@ -45,6 +45,7 @@ There are different entities we can edit in the knowledge model, the editor show
 - :ref:`Question<question>`
 - :ref:`Answer<answer>`
 - :ref:`Choice<choice>`
+- :ref:`Validation<validation>`
 - :ref:`Expert<expert>`
 - :ref:`Metric<metric>`
 - :ref:`Phase<phase>`

docs/applications/data-management-planner/knowledge-models/editors/index.rst

@@ -26,6 +26,13 @@ If there is an ongoing :ref:`knowledge model migration<knowledge-model-migration
 - **Continue migration**
 - **Cancel migration**
 
+The following video explains all aspects of Knowledge Model Editors.
+
+.. youtube:: tYcKRxFNx8U
+    :width: 100%
+    :align: center
+
+
 .. raw:: html
 
     <h2>Table of Contents</h2>

docs/applications/data-management-planner/knowledge-models/list/index.rst

@@ -27,6 +27,9 @@ Finally, there is an option to :doc:`./import` by click the :guilabel:`Import` b
 
     List of all knowledge models with actions.
 
+.. NOTE::
+    Set deprecated option will apply only for the latest version of Knowledge Model. If there is an older version, that will still be available.
+
 .. raw:: html
 
     <h2>Table of Contents</h2>

docs/applications/data-management-planner/projects/list/detail/files.rst

@@ -0,0 +1,18 @@
+.. _files:
+
+Files
+*****
+
+We can see the list of files uploaded to the project in the :guilabel:`Files` tab. 
+
+.. figure:: files/files.png
+
+    List of files in the project detail.
+
+
+Files can be downloaded or deleted.
+
+.. NOTE::
+
+    The :guilabel:`Files` tab is only visible if there are files uploaded to the project.
+

docs/applications/data-management-planner/projects/list/detail/index.rst

@@ -19,5 +19,6 @@ Project detail is where we work on our data management plan. In this section, we
     metrics
     preview
     documents
+    files
     settings
     sharing

docs/applications/data-management-planner/projects/list/detail/questionnaire.rst

@@ -114,7 +114,7 @@ Value Question
 
 Value question contains an input field for our answer. This can be a simple text field (such as asking for a project contributor's name), or some additional widget, for example a date picker.
 
-Some of the value types contains a validation (e.g., email or URL). We can still type in an invalid answer, but it will display a warning and also show it in the list of :ref:`warnings<warnings>`.
+All of value question types (except for color) can have validations set on them. We can still type in an invalid answer, but it will display a warning and also show it in the list of :ref:`warnings<warnings>`.
 
 .. figure:: questionnaire/value-question.png
 
@@ -156,13 +156,10 @@ The item selection question is used together with the list of items question. Wh
 File Question
 -------------
 File question is used when we need to upload a file as an answer. We can simply click on the :guilabel:`Upload File` button and select the file from our computer. We can also drag and drop the file into the input field.
-
-.. TODO::
-    Add a screenshot of the file question.
 
-.. .. figure:: questionnaire/file-question.png
+.. figure:: questionnaire/file-question.png
 
-..     File select question with a list of items as possible answers.
+    File select question with a list of items as possible answers.
 
 
 View settings
@@ -195,7 +192,7 @@ If there are some project importers available for the project, there is the :gui
 Warnings
 ========
 
-Some value questions (such as email or URL) validates the answer written there. If it is an invalid value, we will see :guilabel:`Warnings` tab in the questionnaire menu bar with a badge showing the number of warnings. If we click on it, we can see a list of all questions that has a warning and we can click on it to navigate quickly to that question.
+All of value question types (except for color) can have validations set on them. If it is an invalid value, we will see :guilabel:`Warnings` tab in the questionnaire menu bar with a badge showing the number of warnings. If we click on it, we can see a list of all questions that has a warning and we can click on it to navigate quickly to that question.
 
 .. figure:: questionnaire/warnings.png
     :width: 487

docs/applications/data-management-planner/projects/list/templates.rst

@@ -13,6 +13,13 @@ Project templates are special type of projects where we can set up everything --
 
 When we want to turn a project into a project template we need to go to the :ref:`project settings<project-settings>` and check the :guilabel:`Project Template` checkbox.
 
+The following video explains all aspects of Project Templates.
+
+.. youtube:: 6EJlABTYTLI
+    :width: 100%
+    :align: center
+
+
 Sharing the Project Templates
 =============================
 

docs/conf.py

@@ -26,7 +26,7 @@
 registry_name = 'FAIR Wizard Registry'
 
 # The full version, including alpha/beta/rc tags
-version = release = '4.12'
+version = release = '4.13'
 
 rst_prolog = f"""
 

docs/index.rst

@@ -9,7 +9,7 @@ Once the questionnaire is completed, a DMP can be easily generated using a selec
 
 But the benefits of using |project_name| go beyond just creating a DMP. Institutions can use |project_name| to manage their Data Management Planning processes, using powerful tools provided within the |project_name|. This includes advanced user management, custom integrations with data and more.
 
-.. youtube:: oU6z9V4jW0Q
+.. youtube:: dRiWyimAQMA
     :width: 100%
     :align: center
 

docs/more/development/document-templates/document-context.rst

@@ -438,6 +438,7 @@ ValueQuestion
 '''''''''''''
 
 -  ``value_type`` (``str``) - type of value, use alias
+-  ``validations`` (``list[``\ :ref:`odc-value-question-validation`\ ``]``)
 
 Aliases:
 
@@ -446,6 +447,16 @@ Aliases:
 -  ``is_number`` (``bool``)
 -  ``is_date`` (``bool``)
 
+
+.. _odc-value-question-validation:
+
+ValueQuestionValidation
+"""""""""""""""""""""""
+-  ``type`` (``str``)
+-  ``full_type`` (``str``)
+-  ``value`` (``str | int | float | None``) - based on the ``type``
+
+
 .. _odc-integration-question:
 
 IntegrationQuestion