Add 4.15 (#120) (#121)

krystofkomanec · web-flow · commit 9fdeb9df2dc9 · 2025-02-04T10:18:20.000+01:00
* Add 4.15 guide
diff --git a/docs/applications/admin-center/profile/edit/api-keys.rst b/docs/applications/admin-center/profile/edit/api-keys.rst
@@ -14,3 +14,9 @@ When we want to access the |project_name| through |project_name| API we have to
 After filling out the :guilabel:`API Key Name` and :guilabel:`Expiration`, an **API Key** is generated. In this step we have to copy the API Key, because after seeing it once, it is no longer possible to access it again.
 
 After we click on Done button, the new API Key is hidden and the information about this key is added to the table below, that contains all Active API Keys.
+
+.. NOTE::
+
+    There is only one common API Key for Admin Center, Integration Hub and Analytics. It needs to be set up in this section and then it is used for all three apps. Data Management Plan has its own :ref:`api-keys` that can be set up there.
+
+    
diff --git a/docs/applications/admin-center/profile/edit/index.rst b/docs/applications/admin-center/profile/edit/index.rst
@@ -22,7 +22,7 @@ If we want to :doc:`./password`, we need to switch to :guilabel:`Password` from
 .. toctree::
     :maxdepth: 2
 
-    Change Password<password>
+    Password<password>
     API Keys<api-keys>
     Active Sessions<active-sessions>
-    
+    Submission Settings<submission-settings>
diff --git a/docs/applications/admin-center/profile/edit/password.rst b/docs/applications/admin-center/profile/edit/password.rst
@@ -1,7 +1,7 @@
 .. _password-admin:
 
-Change Password
-***************
+Password
+********
 
 The password be can changed after navigating using :guilabel:`Password` from the :doc:`./index`. Here we can simply enter new password (it must be strong enough), repeat it again and press :guilabel:`Save` button.
 
diff --git a/docs/applications/admin-center/profile/edit/submission-settings.rst b/docs/applications/admin-center/profile/edit/submission-settings.rst
@@ -0,0 +1,13 @@
+.. _submission-settings:
+
+Submission Settings
+*******************
+
+If there are any :ref:`submission-service` configured and require additional user properties, we can set those values under **Submission Settings**. Those properties are then used in the request settings of the submission service. For example, if the submission service requires an API token, we can set it here.
+
+If there is no submission service that requires additional properties, there is a note that no settings are available.
+
+.. NOTE::
+    
+    The admin should notify users about the required properties for the submission service.
+
diff --git a/docs/applications/admin-center/user-groups/detail.rst b/docs/applications/admin-center/user-groups/detail.rst
@@ -3,15 +3,15 @@
 User Group Detail
 *****************
 
-As an admin, we can manage existing user group from User Group Settings. We can change name and description of a group and make it private. If a group is private, then only its members and application admins can see it.
+As an admin, we can manage existing user group from User Group Settings. We can change name and description of a group and make it **private**. If a group is private, then only its members and application admins can see it.
 
 .. figure:: detail/info.png
     :width: 528
     
     User group detail.
 
 
-We can also see list of all members of a group. Each member can be set as either Owner of a group or its member. Member can also be removed from the group by clicking on the x button. We can view users’ profile by clicking his name.
+We can also see list of all members of a group. Each member can be set as either owner of a group or its member. Owner of the group can change the visibility and add or remove its members. The member can only view the user groups he is part of if they are private and view all public user groups. We can view group members’ profile by clicking his name.
 
 .. figure:: detail/members.png
     :width: 528
diff --git a/docs/applications/analytics/document-templates.rst b/docs/applications/analytics/document-templates.rst
@@ -3,7 +3,7 @@
 Document Templates
 ******************
 
-As an administrator, we can view analytics of document templates. We can create and edit views by selecting from many different fields and see how our document templates are doing. The view can be modified and save to be reviewed later. The data can also be exported to a CSV file.
+As an admin, we can view analytics of document templates. We can create and edit views by selecting from many different fields and see how our document templates are doing. The view can be modified and save to be reviewed later. The data can also be exported to a CSV file.
 
 .. figure:: document-templates/overview.png
     :width: 700
diff --git a/docs/applications/analytics/index.rst b/docs/applications/analytics/index.rst
@@ -35,5 +35,6 @@ It is also possible to turn on regular synchronization in settings. This will sy
     Projects<projects>
     Users<users>
     User Groups<user-groups>
+    Settings<settings>
     Profile<profile/index>
     
diff --git a/docs/applications/analytics/profile/edit.rst b/docs/applications/analytics/profile/edit.rst
@@ -1,8 +1,4 @@
 Edit
 ****
 
-After navigating to :guilabel:`Edit profile` from the :doc:`../index` menu, we open the User Settings. We can view our **Email** address, **First name**, **Last name**, and **Affiliation**.
-
-We can see API Keys we have generated.
-
-We can also see Active Sessions and revoke them if needed.
+After navigating to :guilabel:`Edit profile` from the :doc:`../index` menu, the FAIR Wizard takes us to the :ref:`edit-profile-admin`, where we can view and edit profile settings.
diff --git a/docs/applications/analytics/settings.rst b/docs/applications/analytics/settings.rst
@@ -0,0 +1,12 @@
+Settings
+********
+
+Regular Synchronization
+-----------------------
+
+Under system settings we can set up regular synchronization. We can select the time of day when the synchronization will happen. The time is set in your local time zone.
+
+.. TODO::
+
+    Add screenshot of system settings.
+
diff --git a/docs/applications/data-management-planner/administration/locales/create.rst b/docs/applications/data-management-planner/administration/locales/create.rst
@@ -4,3 +4,14 @@ Create Locale
 We can create a new locale directly in |project_name| by pressing :guilabel:`Create` from :doc:`./index`. We need to fill the details about the new locale such as name, description, language code (`RFC5646 <https://www.rfc-editor.org/rfc/rfc5646.html>`__, e.g. ``en`` or ``en-GB``), locale ID, locale version, license, README (with Markdown syntax), and recommended app version. The recommended app version captures for which version of the |project_name| is this locale intended and compatible with (it can be used in other versions as well but may have some untranslated texts).
 
 Finally, a PO file is requested from us. We can create such PO file in a standard (`gettext <https://www.gnu.org/software/gettext/>`__-based) way. The needed POT file is always part of the release attachments of the `wizard client application <https://github.com/ds-wizard/engine-frontend/tags>`__ (select the desired release and there is ``wizard.pot`` asset).
+
+.. TODO:: 
+
+    Add a screenshot of the form.
+
+
+.. TODO::
+
+    Update, that the localization is different and only for the Data Management Planner.
+
+    
diff --git a/docs/applications/data-management-planner/administration/settings/content/document-submission.rst b/docs/applications/data-management-planner/administration/settings/content/document-submission.rst
@@ -5,6 +5,8 @@ If we enable the **Document Submission** feature, users will be able to see :gui
 
 Each service must have its own **ID** (recommended is to use lowercase alphanumeric symbols and dash symbols). Then, we can set human-readable **Name** and **Description** (Markdown-enabled) to clarify for users what is this service and in what cases they should use it. We also need to specify the **Supported Formats**, for each we need to select a document template, its version, and the desired format. Finally, we configure how the document is sent to the external service, the request may contain some **User Properties** (users will be able to set values for them in their user profiles) and it is a HTTP request with a specific **Method**, sent to the **URL**, possibly with HTTP **Headers**. The very last option is to check whether the file should be sent as **Multipart** (with its own **File Name**) instead of plainly in the request body. Most of this configuration should be specified by the external submission service.
 
+If the submission service require additional user properties, we can set those values under :ref:`submission-settings`. For example, if the submission service requires an API token, we can set it there.
+
 .. NOTE::
 
     In case we will update the document template used in **Supported Formats**, we should verify that it is still suitable for the submission service and if yes, then add it as a new entry under **Supported Formats**.
diff --git a/docs/applications/data-management-planner/administration/settings/system/organization.rst b/docs/applications/data-management-planner/administration/settings/system/organization.rst
@@ -3,8 +3,18 @@
 Organization Settings
 *********************
 
-On this page, we can configure **Name**, **Description**, and **Organization ID** for our |project_name|. The organization ID can contain alphanumeric characters and dot symbol (but cannot start or end with dot).
+On this page, we can configure **Name**, **Description**, **Organization ID** for our |project_name| instance and **Affiliations**. The organization ID can contain alphanumeric characters and dot symbol (but cannot start or end with dot).
+
+The organization ID is used as a part of knowledge models and document templates IDs.
+
+The **Affiliations** list is used to pre-define a list of possible affiliations (on per line) that will be suggested to users while they register or update their profiles.
+
+.. TODO::
+
+    Add screenshot
+
 
 .. NOTE::
 
     It is recommended to use period as for domain name or to use it for capturing organizational structure in the ID, for example, ``faculty.university`` or ``group.faculty.university``.
+
diff --git a/docs/applications/data-management-planner/profile/edit/api-keys.rst b/docs/applications/data-management-planner/profile/edit/api-keys.rst
@@ -14,3 +14,7 @@ When we want to access the |project_name| through |project_name| API we have to
 After filling out the :guilabel:`API Key Name` and :guilabel:`Expiration`, an **API Key** is generated. In this step we have to copy the API Key, because after seeing it once, it is no longer possible to access it again.
 
 After we click on Done button, the new API Key is hidden and the information about this key is added to the table below, that contains all Active API Keys.
+
+.. NOTE::
+
+    Data Management Planner has its own API Key. The other apps share common API Key, that can be set up in the :ref:`api-keys-admin` settings in the Admin Center.
diff --git a/docs/applications/data-management-planner/projects/index.rst b/docs/applications/data-management-planner/projects/index.rst
@@ -22,6 +22,6 @@ Projects are mainly used by the researchers. We have the introduction video abou
     :maxdepth: 2
 
     List<list/index>
-    Files<files>
-    Documents<documents>
-    Importers<importers>
+    Files<project-files>
+    Documents<project-documents>
+    Importers<project-importers>
diff --git a/docs/applications/data-management-planner/projects/project-documents.rst b/docs/applications/data-management-planner/projects/project-documents.rst
@@ -1,5 +1,5 @@
-Documents
-*********
+Project Documents
+*****************
 
 As admins, we can quickly browse all documents stored in the |project_name| instance by navigating to :guilabel:`Documents` from the projects menu. It is possible to search for a document by name or sort them using their name or creation timestamp.
 
diff --git a/docs/applications/data-management-planner/projects/project-files.rst b/docs/applications/data-management-planner/projects/project-files.rst
@@ -1,5 +1,5 @@
-Files
-*****
+Project Files
+*************
 
 As admins, we can quickly browse all files stored in the |project_name| instance by navigating to :guilabel:`Files` from the projects menu. It is possible to search for a file by name or sort them using their creation timestamp, name or size.
 
diff --git a/docs/applications/data-management-planner/projects/project-importers.rst b/docs/applications/data-management-planner/projects/project-importers.rst
@@ -22,4 +22,9 @@ If we navigate to :guilabel:`Projects → Importers`, we can see the list of all
     List of project importers where we can enable or disable them.
 
 
-More information about how to develop project importers is available on the :ref:`project importers development<development-importers>` page.
+More information about how to develop project importers is available on the :ref:`project importers development<development-importers>` page.
+
+We can use the project importers to import data into project. We can use either the DSW Replies importer or RDA maDMP Importer:
+
+- DSW Replies importer - imports data from Questionnaire Report JSON document. We can create this with any project (created by any knowledge model) using the Questionnaire Report template. The output JSON can be used to import replies to a different project.
+- RDA maDMP Importer - imports data from RDA maDMP JSON document. This importer relies in a specific project structure and can be only used with Common DSW Knowledge Model and RDA maDMP template used to create the output file, that is then used by the importer. 
diff --git a/docs/applications/integration-hub/profile/edit.rst b/docs/applications/integration-hub/profile/edit.rst
@@ -1,8 +1,4 @@
 Edit
 ****
 
-After navigating to :guilabel:`Edit profile` from the :doc:`../index` menu, we open the User Settings. We can view our **Email** address, **First name**, **Last name**, and **Affiliation**.
-
-We can see API Keys we have generated.
-
-We can also see Active Sessions and revoke them if needed.
+After navigating to :guilabel:`Edit profile` from the :doc:`../index` menu, the FAIR Wizard takes us to the :ref:`edit-profile-admin`, where we can view and edit profile settings.
diff --git a/docs/conf.py b/docs/conf.py
@@ -26,7 +26,7 @@
 registry_name = 'FAIR Wizard Registry'
 
 # The full version, including alpha/beta/rc tags
-version = release = '4.14'
+version = release = '4.15'
 
 rst_prolog = f"""
 
diff --git a/docs/more/development/index.rst b/docs/more/development/index.rst
@@ -22,3 +22,4 @@ This section provides information on how to develop custom content for |project_
     Project Importers<importers>
     submission-service
     Integration via API<api>
+    plugins
diff --git a/docs/more/development/plugins.rst b/docs/more/development/plugins.rst
@@ -0,0 +1,56 @@
+.. _plugins:
+
+Plugins
+*******
+
+It is possible to extend functionality of |project_name| by implementing own plugins according to the instructions and thus add new features to the application. This requires technical knowledge and experience with the relevant technologies used in |project_name| (such as Python or Docker). You should not consider developing plugins unless you are familiar with programming and also will be committed to maintaining the plugin in the future.
+
+Document Worker Plugins
+=======================
+
+.. note::
+
+    The plugin system is still in development and may change in the future versions.
+
+
+Document Worker allows plugins to be installed as Python packages next to the main application and then are automatically loaded thanks to the `setuptools` `entry points <https://setuptools.pypa.io/en/latest/userguide/entry_point.html>`_ and used `Pluggy <https://pluggy.readthedocs.io/en/stable/>`_ library. For this version, the plugins can implement the following interfaces (hooks):
+
+- `provide_steps` - provides additional steps for the document processing workflow (dictionary: step name, step class inheriting from `dsw.document_worker.templates.steps.Step`)
+- `enrich_document_context` - enrich (or otherwise modify) the document context before the processing starts (context is passed as a dictionary in the argument)
+- `enrich_jinja_env` - enrich the Jinja environment used for rendering the templates (environment is passed as an argument), this can be used to add custom filters, tests, or global variables
+
+The Python package implementing the plugin need to import `hookimpl` from `dsw.document_worker.plugins` and then use it as a decorator for the functions implementing the hooks:
+
+.. code-block:: python
+
+    # my_plugin/plugin.py
+    import jinja2
+    from dsw.document_worker.plugins import hookimpl
+    from dsw.document_worker.templates.steps import Step
+
+    @hookimpl
+    def provide_steps() -> dict[str, type[Step]]:
+        return {
+            'my-step': MyStep
+        }
+
+    @hookimpl
+    def enrich_document_context(context: dict) -> None:
+        context['my-key'] = 'my-value'
+
+    @hookimpl
+    def enrich_jinja_env(jinja_env: jinja2.Environment, options: dict) -> None:
+        jinja_env.filters['my_filter'] = my_filter
+
+
+Then, the plugin must specify ``dsw_document_worker_plugins`` entry point, e.g. in the ``pyproject.toml`` file:
+
+.. code-block:: toml
+
+    [project.entry-points.dsw_document_worker_plugins]
+    my_plugin = 'my_plugin.plugin'
+
+
+Finally, if you are running DSW in a Docker container, you need to build a new image with the plugin installed. The plugin package must be installed in the container, one way to do this is to build a new image while using the original DSW image as a base and installing the plugin package in the Dockerfile. For more details, see the `DSW Document Worker: Example Plugin repository <https://github.com/ds-wizard/docworker-example-plugin>`_.
+
+When the plugin is installed and the DSW application is started, the plugin will be automatically loaded and used in the document processing workflow. The document templates may simply use the new steps provided by the plugin, context enriched by the plugin, or custom filters added to the Jinja environment. However, keep in mind that the document templates may be transferred other instances of DSW, so the templates should be as generic as possible and explicitly check presence of such custom things, e.g. via ``{% if my_filter is not defined %}``.
diff --git a/docs/more/miscellaneous/index.rst b/docs/more/miscellaneous/index.rst
@@ -15,5 +15,6 @@ Additional information related to |project_name| that might be useful.
 
     chatbot
     fw-registry
+    keyboard-shortcuts
     markdown-cheatsheet
     
diff --git a/docs/more/miscellaneous/keyboard-shortcuts.rst b/docs/more/miscellaneous/keyboard-shortcuts.rst
@@ -0,0 +1,22 @@
+Keyboard Shortcuts
+******************
+
+Some parts of the application can be controlled using keyboard shortcuts. This page lists all available shortcuts.
+
+Modal Dialogs
+=============
+
+Modal Dialogs are used for various purposes. Example might be a confirmation dialog before deleting an entity. They can be controlled using keyboard shortcuts. The following table lists all available shortcuts:
+
+.. TODO::
+    
+    Add Modal screenshot as an example
+
+
++-------------------+---------------------+
+| Shortcut          | Description         |
++===================+=====================+
+| `ESC`             | Close the dialog    |
++-------------------+---------------------+
+| `Enter`           | Confirm the action  |
++-------------------+---------------------+
