Release 4.26 (preview)

.github/workflows/sphinx.yml

@@ -17,7 +17,7 @@ jobs:
 
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up Python
         uses: actions/setup-python@v6

docs/applications/admin-center/profile/about.rst

@@ -3,11 +3,11 @@
 About
 *****
 
-By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with.
+By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. It also includes information about metamodels together with Project Importers and Project Actions count. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with.
 
 The :guilabel:`API URL` link provides access to the server's API endpoints, which can be used for integrating the Data Stewardship Wizard with other systems and automating tasks.
 
-The :guilabel:`API Documentation` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters.
+The :guilabel:`API Docs` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters.
 
 .. figure:: about/modal.png
     :width: 500

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

@@ -1,38 +1,75 @@
 Open ID Settings
 ****************
 
-Using these settings we can add `Open ID <https://openid.net/>`__ configuration to allow logging into the |project_name| instance via external identity provider. First, press :guilabel:`Create` button and fill **Name** of the service. Then, we should prepare the client application on the side of OpenID service:
+Using these settings we can add `Open ID <https://openid.net/>`__ configuration to allow logging into the |project_name| instance via external identity provider. Here is a detailed description of the setup:
 
-*  Use **Callback URL** (and optionally **Logout URL**) to create the client
-*  Obtain **Client ID** and **Client Secret**
-*  Obtain OpenID endpoint **URL** (we may get one ending with ``/.well-known/openid-configuration``, if so we just use the part before this suffix)
-*  Configure the client to have the following claims: ``openid``, ``profile``, ``email``
-*  Configure the client to provide the following details in ID tokens: ``email``, ``given_name``, ``family_name``
+1. Go to https://portal.azure.com/.
+2. Go to ``App registrations``.
+3. Click on ``New registration``.
+4. Fill in a name.
+5. Select ``Accounts in this organizational directory only (Single tenant)``.
+6. Keep ``Redirect URI`` empty.
+7. Click on ``Register``.
+8. Copy and store ``Directory (tenant) ID`` and ``Application (client) ID``.
+9. Click on ``Manage`` in the left menu → ``Certificates & Secrets``.
+10. Click on ``New client secret``.
+11. Fill description, set ``Expires`` and note it somewhere, then click on ``Add``.
+12. Copy ``Value`` and store it somewhere. You will not able to view it again.
 
-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**.
-
-.. figure:: openid/openid.png
-    :width: 700
-
-    Example configuration of OpenID service.
+13. Create OpenID in FAIR Wizard. Go to :guilabel:`Admin Center` → :guilabel:`Settings` → :guilabel:`Organization OpenID` → :guilabel:`Create`. Fill in :
+	- ``Application (client) ID``
+	- ``Directory (tenant) ID``
+	- ``Client Secret`` → ``<stored secret value>``
 
+14. (optional) fill Icon (``fab fa-microsoft``, or some other from `Font Awesome <https://fontawesome.com/v6/search?o=r&m=free>`_), :guilabel:`Background Color` and :guilabel:`Text Color`.
 
-.. NOTE::
+15. Click on :guilabel:`Save`.
+
+16. Go back to Microsoft Azure.
+17. Click on ``Manage`` in the left menu → ``Authentication (Preview)``.
+18. Click on ``Add Redirect URI``.
+19. Click on ``Web``.
+20. Copy ``Redirect URI`` and ``Front-channel logout URL`` from FAIR Wizard.
+21. **Do not** check any checkbox.
+22. Click on ``Configure``.
+23. Click on ``Manage`` in the left menu → ``API permissions``.
+24. Click on ``Add a permission``.
+25. Click on ``Microsoft Graph`` → ``Delegated permissions``.
+26. Check ``email``, ``openid`` and ``profile`` under ``OpenId permissions`` and keep checked ``User.Read`` under ``User``.
+27. Click on ``Add permissions``.
 
-    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.
+28. Click on ``Manage`` in the left menu → ``Token configuration``.
+29. Click on ``Add optional claim``.
+30. Select ``ID`` and check ``email``, ``given_name``, ``family_name``.
+31. Click on ``Add``.
+
+32. Test your openId in FAIR Wizard (You might need to refresh the login page for the login button to appear).
+
+.. TODO::
+
+    Add screenshot of configured OpenID service.
+
+.. .. figure:: openid/openid.png
+..     :width: 700
+
+..     Example configuration of OpenID service.
+
+Automations
+===========
 
 
 Automations
 ===========
 
 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`.
 
-.. figure:: openid/openid-detail.png
-    :width: 700
+.. .. figure:: openid/openid-detail.png
+..     :width: 700
 
-    Configured OpenID service (with hidden details).
+..     Configured OpenID service (with hidden details).
 
 
 .. NOTE::
 
-    There can be only one automation per login configuration however multiple things can be set up in one automation script.
+	There can be only one automation per login configuration. However, multiple actions can be set up within a single automation script.
+

docs/applications/admin-center/settings/system/locales/create.rst

@@ -5,7 +5,7 @@ We can create a new locale directly in |project_name| by pressing :guilabel:`Cre
 
 Finally, a POT files can be downloaded here. From them, we can create PO files in a standard (`gettext <https://www.gnu.org/software/gettext/>`__-based) way. There is a POT file for each app of FAIR Wizard and also for the emails.
 
-We can :download:`download localization files here<./create/fw-4-24-0-locales.zip>`.
+We can :download:`download localization files here<./create/fw-4-26-0-locales.zip>`.
 
 .. figure:: create/form.png
 

docs/applications/analytics/profile/about.rst

@@ -1,11 +1,11 @@
 About
 *****
 
-By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with.
+By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. It also includes information about metamodels together with Project Importers and Project Actions count. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with.
 
 The :guilabel:`API URL` link provides access to the server's API endpoints, which can be used for integrating the Data Stewardship Wizard with other systems and automating tasks.
 
-The :guilabel:`API Documentation` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters.
+The :guilabel:`API Docs` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters.
 
 .. figure:: about/modal.png
      :width: 500

docs/applications/data-management-planner/profile/about.rst

@@ -3,11 +3,11 @@
 About
 *****
 
-By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with.
+By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. It also includes information about metamodels together with Project Importers and Project Actions count. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with.
 
 The :guilabel:`API URL` link provides access to the server's API endpoints, which can be used for integrating the Data Stewardship Wizard with other systems and automating tasks.
 
-The :guilabel:`API Documentation` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters.
+The :guilabel:`API Docs` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters.
 
 .. figure:: about/modal.png
     :width: 500

docs/applications/data-management-planner/profile/index.rst

@@ -27,4 +27,5 @@ Moreover, there are also options to :guilabel:`Log out`, see basic information a
     User Settings<settings/index>
     Assigned Comments<assigned-comments>
     About<about>
+    News<news>
 

docs/applications/data-management-planner/profile/news.rst

@@ -0,0 +1,15 @@
+.. _planner-news:
+
+What's New
+**********
+
+By selecting the :guilabel:`What's New` option from the :doc:`./index` menu, we can open the News modal. There, we can find information about the most notable updates and changes in FAIR Wizard for each version.
+
+.. TODO::
+
+    Add screenshot
+
+.. .. figure:: about/news.png
+..     :width: 500
+
+..     ...

docs/applications/integration-hub/profile/about.rst

@@ -3,11 +3,11 @@
 About
 *****
 
-By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with.
+By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. It also includes information about metamodels together with Project Importers and Project Actions count. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with.
 
 The :guilabel:`API URL` link provides access to the server's API endpoints, which can be used for integrating the Data Stewardship Wizard with other systems and automating tasks.
 
-The :guilabel:`API Documentation` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters.
+The :guilabel:`API Docs` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters.
 
 .. figure:: about/modal.png
     :width: 500

docs/conf.py

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

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

@@ -115,7 +115,16 @@ Aliases:
 ContextConfig
 ~~~~~~~~~~~~~
 
--  ``client_url`` (``str``) - base URL of the FAIR Wizard instance (client app)
+- ``app_title`` (``str``) - passed by backend from Settings
+- ``app_title_short`` (``str``) - passed by backend from Settings
+- ``client_url`` (``str``) - base URL of the FAIR Wizard instance (client app)
+- ``illustrations_color`` (``str``) - passed by backend from Settings
+- ``logo_url`` (``str``) - passed by backend from Settings
+- ``primary_color`` (``str``) - passed by backend from Settings
+- ``service_domain_name`` (``str``)
+- ``service_name`` (``str``)
+- ``service_name_short`` (``str``)
+- ``service_url`` (``str``)
 
 
 .. _odc-document: