Skip to content
Merged
2 changes: 1 addition & 1 deletion docs/about/introduction/knowledge-model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ When researchers create a new project from the knowledge model, they can only ch
Integration
-----------

Integrations define a connection to an external service or resource where we can get the answers from. They are used with :ref:`integration questions<integration-question>`. For each integration we configure some basic information, such as **ID**, **Name**, or **Logo URL**. Other configuration varies based on the integration type. More information about how to configure integration is available under the :ref:`integration questions documentation<integration_questions>`.
Integrations define a connection to an external service or resource where we can get the answers from. They are used with :ref:`integration questions<integration-question>`. For each integration we configure some basic information, such as **ID**, **Name**, or **Logo URL**. Other configuration varies based on the integration type. More information about how to configure integration is available under the :ref:`integration questions documentation<integration-questions>`.

API Integration
^^^^^^^^^^^^^^^
Expand Down
Binary file modified docs/applications/admin-center/audit-log/index/detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/automations/automations/list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/applications/admin-center/profile/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
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. 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.
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. 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.

Expand Down
Binary file modified docs/applications/admin-center/profile/about/modal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/profile/settings/index/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/settings/info/plans/list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/settings/info/usage/table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -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-26-0-locales.zip>`.
We can :download:`download localization files here<./create/fw-4-27-locales.zip>`.

.. figure:: create/form.png

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/settings/system/locales/list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/settings/system/users/users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/user-groups/detail/info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/admin-center/users/invite/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/analytics/document-templates/detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/analytics/document-templates/overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/applications/analytics/knowledge-models/overview.png
2 changes: 1 addition & 1 deletion docs/applications/analytics/profile/about.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
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. 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.
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 and plugins. 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.

Expand Down
Binary file modified docs/applications/analytics/profile/about/modal.png
Binary file modified docs/applications/analytics/projects/detail.png
Binary file modified docs/applications/analytics/projects/overview.png
Binary file modified docs/applications/analytics/settings/form.png
Binary file modified docs/applications/analytics/user-groups/overview.png
Binary file modified docs/applications/analytics/user-groups/settings.png
Binary file modified docs/applications/analytics/users/detail.png
Binary file modified docs/applications/analytics/users/overview.png
Binary file modified docs/applications/analytics/users/settings.png
18 changes: 0 additions & 18 deletions docs/applications/data-management-planner/administration/index.rst

This file was deleted.

Diff not rendered.
Diff not rendered.
2 changes: 1 addition & 1 deletion docs/applications/data-management-planner/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ Data Management Planner is an application for collaborative and effective creati
Knowledge Models<knowledge-models/index>
Document Templates<document-templates/index>
Projects<projects/index>
Administration<administration/index>
Settings<settings/index>
Profile<profile/index>

Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ Knowledge Model Preview

The preview feature for knowledge models allows us to check the content, i.e. how the questionnaire looks like. It can be used to navigate just through the top-level questions. However, with a know UUID of the question, we can create a direct link to a certain question:

For a nested question, all needed question above in the tree will be automatically prefilled. The KM preview may be also available to non-logged-in users, if configured by admins in :doc:`../../administration/settings/content/knowledge-models`.
For a nested question, all needed question above in the tree will be automatically prefilled. The KM preview may be also available to non-logged-in users, if configured by admins in :doc:`../../settings/content/knowledge-models`.

A user can directly create a new project from the KM preview. Again, this can be available also for non-logged-in users if anonymous projects are enabled by administrations in :doc:`../../administration/settings/content/projects`.
A user can directly create a new project from the KM preview. Again, this can be available also for non-logged-in users if anonymous projects are enabled by administrations in :doc:`../../settings/content/projects`.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
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. 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.
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. 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.

Expand Down
Binary file modified docs/applications/data-management-planner/profile/about/modal.png
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ This section covers different settings available to admin users. The settings ar
.. toctree::
:maxdepth: 2

System<system/index>
User Interface<user-interface/index>
Content<content/index>
Info<info/index>
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
System
******

The system section of settings for now allows us to toggle and configure plugins.

----

.. raw:: html

<h2>Table of Contents</h2>

.. toctree::
:maxdepth: 2

Plugins<plugins>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Plugins
*******

Plugins allows us to toggle and configure plugins. For now, there are two plugins available, which are two importers:

- **Replies Importer:** Importer for replies in JSON exported from Data Management Planner.
- **maDMP Importer:** Importer for maDMPs according to RDA DMP Common Standard.

.. figure:: plugins/plugins.png

Plugins configuration.
2 changes: 1 addition & 1 deletion docs/applications/integration-hub/profile/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
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. 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.
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 and plugins. 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.

Expand Down
Binary file modified docs/applications/integration-hub/profile/about/modal.png
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
registry_name = 'FAIR Wizard Registry'

# The full version, including alpha/beta/rc tags
version = release = '4.26'
version = release = '4.27'

rst_prolog = f"""

Expand Down
6 changes: 4 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ 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.

You are welcome to join the `DSW Discord community <https://discord.gg/MW3H9tdMcT>`__ where you can ask questions, share your experience, and get help from other users and administrators.

.. youtube:: dRiWyimAQMA
:width: 100%
:align: center
Expand Down Expand Up @@ -70,7 +72,7 @@ Here are some recommended sections where to start based on the role:
- :ref:`user-groups`
* -
- :ref:`user-groups`
- :ref:`administration`
- :ref:`settings`
* -
- :ref:`project-templates`
- :ref:`settings`
Expand All @@ -84,7 +86,7 @@ Here are some recommended sections where to start based on the role:
- :ref:`document-template-development`
- :ref:`submission-service`
* -
- :ref:`integration_questions`
- :ref:`integration-questions`
- `Changelog <https://fair-wizard.com/changelog>`__
* -
- :ref:`importers`
Expand Down
2 changes: 1 addition & 1 deletion docs/more/development/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Development
***********

|project_name| can be extended in many ways and new components and ways of integrations can be developed to support our needs. Besides the API available for everything that can be done in |project_name|, new :ref:`integration questions<integration_questions>` and :ref:`project importers<development-importers>` can be implemented to get data from outside to |project_name|, or new :ref:`document templates<document-template-development>` and :ref:`submission services<submission-service>` can be created to get the data outside of |project_name| in the desired form.
|project_name| can be extended in many ways and new components and ways of integrations can be developed to support our needs. Besides the API available for everything that can be done in |project_name|, new :ref:`integration questions<integration-questions>` and :ref:`project importers<development-importers>` can be implemented to get data from outside to |project_name|, or new :ref:`document templates<document-template-development>` and :ref:`submission services<submission-service>` can be created to get the data outside of |project_name| in the desired form.

This section provides information on how to develop custom content for |project_name| to fully tailor the tool to our specific requirements.

Expand Down
2 changes: 1 addition & 1 deletion docs/more/development/integration-questions/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _integration_questions:
.. _integration-questions:

Integration Questions
*********************
Expand Down
2 changes: 1 addition & 1 deletion docs/more/development/submission-service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Submission Service
******************

As admins, we can configure submission services using :doc:`../../applications/data-management-planner/administration/settings/content/document-submission`. The configured HTTP request is then used when a user clicks :guilabel:`Submit` for an allowed document for submission and selected the desired submission service. The document is sent as a body of the request (or as multipart, based on the configuration) to the external service that should process it and return HTTP response with status code, and possibly also the `Location` header and some textual message.
As admins, we can configure submission services using :doc:`../../applications/data-management-planner/settings/content/document-submission`. The configured HTTP request is then used when a user clicks :guilabel:`Submit` for an allowed document for submission and selected the desired submission service. The document is sent as a body of the request (or as multipart, based on the configuration) to the external service that should process it and return HTTP response with status code, and possibly also the `Location` header and some textual message.

Usually, we will need a simple proxy service to be developed that will accommodate this to API of some information system, database, storage, or other service. For example, such a proxy service will be able to receive the JSON documents from |project_name|, retrieve additional information through |project_name| API as needed, transform it to some other resulting artifact and store it in some local database that is used by other systems.

Expand Down