diff --git a/docs/about/introduction/knowledge-model.rst b/docs/about/introduction/knowledge-model.rst index 93261c6a..2ff3fcc4 100644 --- a/docs/about/introduction/knowledge-model.rst +++ b/docs/about/introduction/knowledge-model.rst @@ -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`. 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`. +Integrations define a connection to an external service or resource where we can get the answers from. They are used with :ref:`integration questions`. 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`. API Integration ^^^^^^^^^^^^^^^ diff --git a/docs/applications/admin-center/audit-log/index/detail.png b/docs/applications/admin-center/audit-log/index/detail.png index 33691677..9b0a9ee0 100644 Binary files a/docs/applications/admin-center/audit-log/index/detail.png and b/docs/applications/admin-center/audit-log/index/detail.png differ diff --git a/docs/applications/admin-center/automations/automations/list.png b/docs/applications/admin-center/automations/automations/list.png index 20ade319..5d73d5bc 100644 Binary files a/docs/applications/admin-center/automations/automations/list.png and b/docs/applications/admin-center/automations/automations/list.png differ diff --git a/docs/applications/admin-center/profile/about.rst b/docs/applications/admin-center/profile/about.rst index 82feb0b3..c9d37ab8 100644 --- a/docs/applications/admin-center/profile/about.rst +++ b/docs/applications/admin-center/profile/about.rst @@ -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. diff --git a/docs/applications/admin-center/profile/about/modal.png b/docs/applications/admin-center/profile/about/modal.png index 16a93d34..f96d4f6d 100644 Binary files a/docs/applications/admin-center/profile/about/modal.png and b/docs/applications/admin-center/profile/about/modal.png differ diff --git a/docs/applications/admin-center/profile/settings/active-sessions/form.png b/docs/applications/admin-center/profile/settings/active-sessions/form.png index e5ade9d0..312d63f0 100644 Binary files a/docs/applications/admin-center/profile/settings/active-sessions/form.png and b/docs/applications/admin-center/profile/settings/active-sessions/form.png differ diff --git a/docs/applications/admin-center/profile/settings/index/form.png b/docs/applications/admin-center/profile/settings/index/form.png index 90356c81..8569d022 100644 Binary files a/docs/applications/admin-center/profile/settings/index/form.png and b/docs/applications/admin-center/profile/settings/index/form.png differ diff --git a/docs/applications/admin-center/profile/settings/language/form.png b/docs/applications/admin-center/profile/settings/language/form.png index 77119822..f4870b19 100644 Binary files a/docs/applications/admin-center/profile/settings/language/form.png and b/docs/applications/admin-center/profile/settings/language/form.png differ diff --git a/docs/applications/admin-center/settings/authentication/internal/internal.png b/docs/applications/admin-center/settings/authentication/internal/internal.png index d98eb6ea..b9decfc0 100644 Binary files a/docs/applications/admin-center/settings/authentication/internal/internal.png and b/docs/applications/admin-center/settings/authentication/internal/internal.png differ diff --git a/docs/applications/admin-center/settings/authentication/openid/openid.png b/docs/applications/admin-center/settings/authentication/openid/openid.png index f041cf1c..e236d760 100644 Binary files a/docs/applications/admin-center/settings/authentication/openid/openid.png and b/docs/applications/admin-center/settings/authentication/openid/openid.png differ diff --git a/docs/applications/admin-center/settings/authentication/saml/saml.png b/docs/applications/admin-center/settings/authentication/saml/saml.png index 6bedf7c3..88dd9a8a 100644 Binary files a/docs/applications/admin-center/settings/authentication/saml/saml.png and b/docs/applications/admin-center/settings/authentication/saml/saml.png differ diff --git a/docs/applications/admin-center/settings/info/plans/list.png b/docs/applications/admin-center/settings/info/plans/list.png index 1531b07f..ad6fe7f3 100644 Binary files a/docs/applications/admin-center/settings/info/plans/list.png and b/docs/applications/admin-center/settings/info/plans/list.png differ diff --git a/docs/applications/admin-center/settings/info/usage/table.png b/docs/applications/admin-center/settings/info/usage/table.png index 934f1db3..e4b20dea 100644 Binary files a/docs/applications/admin-center/settings/info/usage/table.png and b/docs/applications/admin-center/settings/info/usage/table.png differ diff --git a/docs/applications/admin-center/settings/system/features/features.png b/docs/applications/admin-center/settings/system/features/features.png index 8f32811a..f925e90d 100644 Binary files a/docs/applications/admin-center/settings/system/features/features.png and b/docs/applications/admin-center/settings/system/features/features.png differ diff --git a/docs/applications/admin-center/settings/system/locales/create.rst b/docs/applications/admin-center/settings/system/locales/create.rst index 47376b98..638cd15b 100644 --- a/docs/applications/admin-center/settings/system/locales/create.rst +++ b/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 `__-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 diff --git a/docs/applications/admin-center/settings/system/locales/create/form.png b/docs/applications/admin-center/settings/system/locales/create/form.png index 66d8297c..2e851040 100644 Binary files a/docs/applications/admin-center/settings/system/locales/create/form.png and b/docs/applications/admin-center/settings/system/locales/create/form.png differ diff --git a/docs/applications/admin-center/settings/system/locales/create/fw-4-26-0-locales.zip b/docs/applications/admin-center/settings/system/locales/create/fw-4-26-0-locales.zip deleted file mode 100644 index 1c776b88..00000000 Binary files a/docs/applications/admin-center/settings/system/locales/create/fw-4-26-0-locales.zip and /dev/null differ diff --git a/docs/applications/admin-center/settings/system/locales/create/fw-4-27-locales.zip b/docs/applications/admin-center/settings/system/locales/create/fw-4-27-locales.zip new file mode 100644 index 00000000..1414088f Binary files /dev/null and b/docs/applications/admin-center/settings/system/locales/create/fw-4-27-locales.zip differ diff --git a/docs/applications/admin-center/settings/system/locales/import/file.png b/docs/applications/admin-center/settings/system/locales/import/file.png index fc93e23f..5696f0d2 100644 Binary files a/docs/applications/admin-center/settings/system/locales/import/file.png and b/docs/applications/admin-center/settings/system/locales/import/file.png differ diff --git a/docs/applications/admin-center/settings/system/locales/list.png b/docs/applications/admin-center/settings/system/locales/list.png index c05c5a1e..162ffada 100644 Binary files a/docs/applications/admin-center/settings/system/locales/list.png and b/docs/applications/admin-center/settings/system/locales/list.png differ diff --git a/docs/applications/admin-center/settings/system/organization/organization.png b/docs/applications/admin-center/settings/system/organization/organization.png index 427cf9bc..daef9542 100644 Binary files a/docs/applications/admin-center/settings/system/organization/organization.png and b/docs/applications/admin-center/settings/system/organization/organization.png differ diff --git a/docs/applications/admin-center/settings/system/support/support.png b/docs/applications/admin-center/settings/system/support/support.png index c7df9f02..d55eb2d4 100644 Binary files a/docs/applications/admin-center/settings/system/support/support.png and b/docs/applications/admin-center/settings/system/support/support.png differ diff --git a/docs/applications/admin-center/settings/system/users/users.png b/docs/applications/admin-center/settings/system/users/users.png index 905ea316..08d531f1 100644 Binary files a/docs/applications/admin-center/settings/system/users/users.png and b/docs/applications/admin-center/settings/system/users/users.png differ diff --git a/docs/applications/admin-center/settings/user-interface/dashboard-and-login/dashboard-and-login.png b/docs/applications/admin-center/settings/user-interface/dashboard-and-login/dashboard-and-login.png index 1eb054e0..2da632ab 100644 Binary files a/docs/applications/admin-center/settings/user-interface/dashboard-and-login/dashboard-and-login.png and b/docs/applications/admin-center/settings/user-interface/dashboard-and-login/dashboard-and-login.png differ diff --git a/docs/applications/admin-center/settings/user-interface/look-and-feel/colors.png b/docs/applications/admin-center/settings/user-interface/look-and-feel/colors.png index 43643d2b..c4726544 100644 Binary files a/docs/applications/admin-center/settings/user-interface/look-and-feel/colors.png and b/docs/applications/admin-center/settings/user-interface/look-and-feel/colors.png differ diff --git a/docs/applications/admin-center/settings/user-interface/look-and-feel/custom-menu-links.png b/docs/applications/admin-center/settings/user-interface/look-and-feel/custom-menu-links.png index dee1dd61..50de2a70 100644 Binary files a/docs/applications/admin-center/settings/user-interface/look-and-feel/custom-menu-links.png and b/docs/applications/admin-center/settings/user-interface/look-and-feel/custom-menu-links.png differ diff --git a/docs/applications/admin-center/user-groups/detail/info.png b/docs/applications/admin-center/user-groups/detail/info.png index cbbbe9b2..4d28e872 100644 Binary files a/docs/applications/admin-center/user-groups/detail/info.png and b/docs/applications/admin-center/user-groups/detail/info.png differ diff --git a/docs/applications/admin-center/users/invite/form.png b/docs/applications/admin-center/users/invite/form.png index 5e90cf28..7334486f 100644 Binary files a/docs/applications/admin-center/users/invite/form.png and b/docs/applications/admin-center/users/invite/form.png differ diff --git a/docs/applications/analytics/document-templates/detail.png b/docs/applications/analytics/document-templates/detail.png index 4ca020e8..63f0886e 100644 Binary files a/docs/applications/analytics/document-templates/detail.png and b/docs/applications/analytics/document-templates/detail.png differ diff --git a/docs/applications/analytics/document-templates/overview.png b/docs/applications/analytics/document-templates/overview.png index 6169557e..74e94e99 100644 Binary files a/docs/applications/analytics/document-templates/overview.png and b/docs/applications/analytics/document-templates/overview.png differ diff --git a/docs/applications/analytics/knowledge-models/overview.png b/docs/applications/analytics/knowledge-models/overview.png index ef63486c..aeba1b13 100644 Binary files a/docs/applications/analytics/knowledge-models/overview.png and b/docs/applications/analytics/knowledge-models/overview.png differ diff --git a/docs/applications/analytics/profile/about.rst b/docs/applications/analytics/profile/about.rst index 840d34b7..67f88746 100644 --- a/docs/applications/analytics/profile/about.rst +++ b/docs/applications/analytics/profile/about.rst @@ -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. diff --git a/docs/applications/analytics/profile/about/modal.png b/docs/applications/analytics/profile/about/modal.png index 49bc4210..724acf86 100644 Binary files a/docs/applications/analytics/profile/about/modal.png and b/docs/applications/analytics/profile/about/modal.png differ diff --git a/docs/applications/analytics/projects/detail.png b/docs/applications/analytics/projects/detail.png index 07c9134e..4847cbef 100644 Binary files a/docs/applications/analytics/projects/detail.png and b/docs/applications/analytics/projects/detail.png differ diff --git a/docs/applications/analytics/projects/overview.png b/docs/applications/analytics/projects/overview.png index b77f01a5..1eed231f 100644 Binary files a/docs/applications/analytics/projects/overview.png and b/docs/applications/analytics/projects/overview.png differ diff --git a/docs/applications/analytics/settings/form.png b/docs/applications/analytics/settings/form.png index 243fd940..5871a290 100644 Binary files a/docs/applications/analytics/settings/form.png and b/docs/applications/analytics/settings/form.png differ diff --git a/docs/applications/analytics/user-groups/overview.png b/docs/applications/analytics/user-groups/overview.png index 3442db87..300ef494 100644 Binary files a/docs/applications/analytics/user-groups/overview.png and b/docs/applications/analytics/user-groups/overview.png differ diff --git a/docs/applications/analytics/user-groups/settings.png b/docs/applications/analytics/user-groups/settings.png index 50c68d7e..326c7fef 100644 Binary files a/docs/applications/analytics/user-groups/settings.png and b/docs/applications/analytics/user-groups/settings.png differ diff --git a/docs/applications/analytics/users/detail.png b/docs/applications/analytics/users/detail.png index c4a9f322..178d0db8 100644 Binary files a/docs/applications/analytics/users/detail.png and b/docs/applications/analytics/users/detail.png differ diff --git a/docs/applications/analytics/users/overview.png b/docs/applications/analytics/users/overview.png index 3da2d9a8..db76dc7c 100644 Binary files a/docs/applications/analytics/users/overview.png and b/docs/applications/analytics/users/overview.png differ diff --git a/docs/applications/analytics/users/settings.png b/docs/applications/analytics/users/settings.png index 65f7be69..b4c80601 100644 Binary files a/docs/applications/analytics/users/settings.png and b/docs/applications/analytics/users/settings.png differ diff --git a/docs/applications/data-management-planner/administration/index.rst b/docs/applications/data-management-planner/administration/index.rst deleted file mode 100644 index 01530ac1..00000000 --- a/docs/applications/data-management-planner/administration/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _administration: - -Administration -************** - -Administration section serves admins with managing the |project_name|. By navigating via :guilabel:`Administration` item from the main menu, we can manage the things listed below. - ----- - -.. raw:: html - -

Table of Contents

- - -.. toctree:: - :maxdepth: 2 - - settings/index diff --git a/docs/applications/data-management-planner/administration/settings/info/usage/usage.png b/docs/applications/data-management-planner/administration/settings/info/usage/usage.png deleted file mode 100644 index bda552c2..00000000 Binary files a/docs/applications/data-management-planner/administration/settings/info/usage/usage.png and /dev/null differ diff --git a/docs/applications/data-management-planner/administration/settings/user-interface/menu/custom-links.png b/docs/applications/data-management-planner/administration/settings/user-interface/menu/custom-links.png deleted file mode 100644 index 3fecc3e9..00000000 Binary files a/docs/applications/data-management-planner/administration/settings/user-interface/menu/custom-links.png and /dev/null differ diff --git a/docs/applications/data-management-planner/document-templates/editors/create/create-document-template.png b/docs/applications/data-management-planner/document-templates/editors/create/create-document-template.png index 03696861..50fc0eb5 100644 Binary files a/docs/applications/data-management-planner/document-templates/editors/create/create-document-template.png and b/docs/applications/data-management-planner/document-templates/editors/create/create-document-template.png differ diff --git a/docs/applications/data-management-planner/document-templates/editors/detail/preview/preview.png b/docs/applications/data-management-planner/document-templates/editors/detail/preview/preview.png index cb9cc38c..6d977c36 100644 Binary files a/docs/applications/data-management-planner/document-templates/editors/detail/preview/preview.png and b/docs/applications/data-management-planner/document-templates/editors/detail/preview/preview.png differ diff --git a/docs/applications/data-management-planner/document-templates/editors/detail/publish/modal.png b/docs/applications/data-management-planner/document-templates/editors/detail/publish/modal.png index 0b35778b..1f317f8b 100644 Binary files a/docs/applications/data-management-planner/document-templates/editors/detail/publish/modal.png and b/docs/applications/data-management-planner/document-templates/editors/detail/publish/modal.png differ diff --git a/docs/applications/data-management-planner/document-templates/list/detail/detail.png b/docs/applications/data-management-planner/document-templates/list/detail/detail.png index 9219e775..34f5166e 100644 Binary files a/docs/applications/data-management-planner/document-templates/list/detail/detail.png and b/docs/applications/data-management-planner/document-templates/list/detail/detail.png differ diff --git a/docs/applications/data-management-planner/document-templates/list/index/list.png b/docs/applications/data-management-planner/document-templates/list/index/list.png index 4869c8fd..ed0aec0f 100644 Binary files a/docs/applications/data-management-planner/document-templates/list/index/list.png and b/docs/applications/data-management-planner/document-templates/list/index/list.png differ diff --git a/docs/applications/data-management-planner/index.rst b/docs/applications/data-management-planner/index.rst index 8e20a5c0..d9172556 100644 --- a/docs/applications/data-management-planner/index.rst +++ b/docs/applications/data-management-planner/index.rst @@ -18,6 +18,6 @@ Data Management Planner is an application for collaborative and effective creati Knowledge Models Document Templates Projects - Administration + Settings Profile \ No newline at end of file diff --git a/docs/applications/data-management-planner/knowledge-models/editors/create/create-knowledge-model.png b/docs/applications/data-management-planner/knowledge-models/editors/create/create-knowledge-model.png index 68a4d8e3..d17332ef 100644 Binary files a/docs/applications/data-management-planner/knowledge-models/editors/create/create-knowledge-model.png and b/docs/applications/data-management-planner/knowledge-models/editors/create/create-knowledge-model.png differ diff --git a/docs/applications/data-management-planner/knowledge-models/editors/index/knowledge-model-editors-list.png b/docs/applications/data-management-planner/knowledge-models/editors/index/knowledge-model-editors-list.png index 97484ead..eea6672d 100644 Binary files a/docs/applications/data-management-planner/knowledge-models/editors/index/knowledge-model-editors-list.png and b/docs/applications/data-management-planner/knowledge-models/editors/index/knowledge-model-editors-list.png differ diff --git a/docs/applications/data-management-planner/knowledge-models/list/detail.rst b/docs/applications/data-management-planner/knowledge-models/list/detail.rst index 28e7b73c..fb6ff47e 100644 --- a/docs/applications/data-management-planner/knowledge-models/list/detail.rst +++ b/docs/applications/data-management-planner/knowledge-models/list/detail.rst @@ -17,7 +17,14 @@ In the top pane, we can see the options based on our role: - :guilabel:`Fork KM` is again a shortcut for :doc:`../editors/create` for to create a fork (some more specific KM based on this one). - :guilabel:`Create project` is a shortcut to :doc:`../../projects/list/create` with this KM. - :guilabel:`Set deprecated` or :guilabel:`Restore` for setting a KM deprecated when we no longer want the **researchers** to use it. -- :guilabel:`Delete` the specific version of the KM (possible only if is not used in any projects or linked in other KMs and editors, cannot be undone). +- :guilabel:`Delete` for all versions of the KM. (Single version can be deleted from the KM's :doc:`./detail` page). + +.. WARNING:: + + It is possible to force delete a KM. Doing so will delete all KM versions, all KM editors based on this KM and all projects based on this KM, as well as all documents and files related to these projects. + + This action is irreversible, so be careful when doing it. + If we are not seeing the latest version of the KM, 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 `__. diff --git a/docs/applications/data-management-planner/knowledge-models/list/detail/detail.png b/docs/applications/data-management-planner/knowledge-models/list/detail/detail.png index ec7af67e..c8ba4752 100644 Binary files a/docs/applications/data-management-planner/knowledge-models/list/detail/detail.png and b/docs/applications/data-management-planner/knowledge-models/list/detail/detail.png differ diff --git a/docs/applications/data-management-planner/knowledge-models/list/index/list.png b/docs/applications/data-management-planner/knowledge-models/list/index/list.png index f7ff1b79..1cd81c1d 100644 Binary files a/docs/applications/data-management-planner/knowledge-models/list/index/list.png and b/docs/applications/data-management-planner/knowledge-models/list/index/list.png differ diff --git a/docs/applications/data-management-planner/knowledge-models/list/preview.rst b/docs/applications/data-management-planner/knowledge-models/list/preview.rst index f64d700e..d9e5af27 100644 --- a/docs/applications/data-management-planner/knowledge-models/list/preview.rst +++ b/docs/applications/data-management-planner/knowledge-models/list/preview.rst @@ -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`. diff --git a/docs/applications/data-management-planner/profile/about.rst b/docs/applications/data-management-planner/profile/about.rst index f0774a0b..ce9c3f5c 100644 --- a/docs/applications/data-management-planner/profile/about.rst +++ b/docs/applications/data-management-planner/profile/about.rst @@ -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. diff --git a/docs/applications/data-management-planner/profile/about/modal.png b/docs/applications/data-management-planner/profile/about/modal.png index 1e4432a9..d25ea329 100644 Binary files a/docs/applications/data-management-planner/profile/about/modal.png and b/docs/applications/data-management-planner/profile/about/modal.png differ diff --git a/docs/applications/data-management-planner/profile/settings/active-sessions/form.png b/docs/applications/data-management-planner/profile/settings/active-sessions/form.png index cadf70f6..8414b346 100644 Binary files a/docs/applications/data-management-planner/profile/settings/active-sessions/form.png and b/docs/applications/data-management-planner/profile/settings/active-sessions/form.png differ diff --git a/docs/applications/data-management-planner/projects/documents/documents.png b/docs/applications/data-management-planner/projects/documents/documents.png index 74020efc..9e3edeef 100644 Binary files a/docs/applications/data-management-planner/projects/documents/documents.png and b/docs/applications/data-management-planner/projects/documents/documents.png differ diff --git a/docs/applications/data-management-planner/projects/importers.rst b/docs/applications/data-management-planner/projects/importers.rst deleted file mode 100644 index fd3804a2..00000000 --- a/docs/applications/data-management-planner/projects/importers.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _importers: - -Importers -********* - -.. WARNING:: - - Project importers are an experimental feature. - - -We can use project importers to import data from different |project_name| or even different applications to |project_name|. Each has a set of supported knowledge models defined. This is because each knowledge model has a different structure and the importer needs to understand it so it can import the answers to the correct questions. - -.. NOTE:: - - Only data stewards or admins can access project importers. - - -If we navigate to :guilabel:`Projects → Importers`, we can see the list of all available importers. We can enable or disable them by clicking on the triple dots icon and choosing the appropriate action. - -.. figure:: importers/importers.png - - 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` 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/data-management-planner/projects/importers/importers.png b/docs/applications/data-management-planner/projects/importers/importers.png deleted file mode 100644 index 1774715c..00000000 Binary files a/docs/applications/data-management-planner/projects/importers/importers.png and /dev/null differ diff --git a/docs/applications/data-management-planner/projects/index.rst b/docs/applications/data-management-planner/projects/index.rst index c5da37fe..3baa0bd0 100644 --- a/docs/applications/data-management-planner/projects/index.rst +++ b/docs/applications/data-management-planner/projects/index.rst @@ -24,4 +24,3 @@ Projects are mainly used by the researchers. Watch this video to see the basic r List Files Documents - Importers diff --git a/docs/applications/data-management-planner/projects/list/detail/documents/new.png b/docs/applications/data-management-planner/projects/list/detail/documents/new.png index 9b6abce5..80198847 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/documents/new.png and b/docs/applications/data-management-planner/projects/list/detail/documents/new.png differ diff --git a/docs/applications/data-management-planner/projects/list/detail/index/questionnaire.png b/docs/applications/data-management-planner/projects/list/detail/index/questionnaire.png index dfdce386..11dc4dd9 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/index/questionnaire.png and b/docs/applications/data-management-planner/projects/list/detail/index/questionnaire.png differ diff --git a/docs/applications/data-management-planner/projects/list/detail/questionnaire.rst b/docs/applications/data-management-planner/projects/list/detail/questionnaire.rst index b0cc1e6b..841e2900 100644 --- a/docs/applications/data-management-planner/projects/list/detail/questionnaire.rst +++ b/docs/applications/data-management-planner/projects/list/detail/questionnaire.rst @@ -190,9 +190,9 @@ In the questionnaire tab, there is a menu bar with various options. The first on Import answers ============== -Questionnaire answers can be imported for various sources using :ref:`project importers`. +Questionnaire answers can be imported for various sources using :ref:`plugins`. -If there are some project importers available for the project, there is the :guilabel:`Import answers` button in the questionnaire menu bar. We can choose one of the available importers there and then follow the instructions in the importer window. +If there are some project importer plugins available for the project, there is the :guilabel:`Import answers` button in the questionnaire menu bar. We can choose one of the available importer plugins there and then follow the instructions in the importer plugin window. .. _warnings: diff --git a/docs/applications/data-management-planner/projects/list/detail/questionnaire/file-question.png b/docs/applications/data-management-planner/projects/list/detail/questionnaire/file-question.png index d56b86f0..aa9115ac 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/questionnaire/file-question.png and b/docs/applications/data-management-planner/projects/list/detail/questionnaire/file-question.png differ diff --git a/docs/applications/data-management-planner/projects/list/detail/questionnaire/list-of-items-question.png b/docs/applications/data-management-planner/projects/list/detail/questionnaire/list-of-items-question.png index 266afdef..ea8444b7 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/questionnaire/list-of-items-question.png and b/docs/applications/data-management-planner/projects/list/detail/questionnaire/list-of-items-question.png differ diff --git a/docs/applications/data-management-planner/projects/list/detail/questionnaire/options-question.png b/docs/applications/data-management-planner/projects/list/detail/questionnaire/options-question.png index 4e49dd00..08e4b971 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/questionnaire/options-question.png and b/docs/applications/data-management-planner/projects/list/detail/questionnaire/options-question.png differ diff --git a/docs/applications/data-management-planner/projects/list/detail/questionnaire/todos.png b/docs/applications/data-management-planner/projects/list/detail/questionnaire/todos.png index 37190758..41e73949 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/questionnaire/todos.png and b/docs/applications/data-management-planner/projects/list/detail/questionnaire/todos.png differ diff --git a/docs/applications/data-management-planner/projects/list/detail/questionnaire/value-question.png b/docs/applications/data-management-planner/projects/list/detail/questionnaire/value-question.png index 4d6f4612..2818e5ff 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/questionnaire/value-question.png and b/docs/applications/data-management-planner/projects/list/detail/questionnaire/value-question.png differ diff --git a/docs/applications/data-management-planner/projects/list/detail/questionnaire/version-history.png b/docs/applications/data-management-planner/projects/list/detail/questionnaire/version-history.png index c64cda24..8296fca1 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/questionnaire/version-history.png and b/docs/applications/data-management-planner/projects/list/detail/questionnaire/version-history.png differ diff --git a/docs/applications/data-management-planner/projects/list/detail/questionnaire/view-options.png b/docs/applications/data-management-planner/projects/list/detail/questionnaire/view-options.png index 1708f220..f3183fb0 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/questionnaire/view-options.png and b/docs/applications/data-management-planner/projects/list/detail/questionnaire/view-options.png differ diff --git a/docs/applications/data-management-planner/projects/list/detail/settings/settings.png b/docs/applications/data-management-planner/projects/list/detail/settings/settings.png index fcc11fd3..47734439 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/settings/settings.png and b/docs/applications/data-management-planner/projects/list/detail/settings/settings.png differ diff --git a/docs/applications/data-management-planner/projects/list/index/project-list.png b/docs/applications/data-management-planner/projects/list/index/project-list.png index 5fbae3b3..204f2d6e 100644 Binary files a/docs/applications/data-management-planner/projects/list/index/project-list.png and b/docs/applications/data-management-planner/projects/list/index/project-list.png differ diff --git a/docs/applications/data-management-planner/administration/settings/content/document-submission.rst b/docs/applications/data-management-planner/settings/content/document-submission.rst similarity index 100% rename from docs/applications/data-management-planner/administration/settings/content/document-submission.rst rename to docs/applications/data-management-planner/settings/content/document-submission.rst diff --git a/docs/applications/data-management-planner/administration/settings/content/index.rst b/docs/applications/data-management-planner/settings/content/index.rst similarity index 100% rename from docs/applications/data-management-planner/administration/settings/content/index.rst rename to docs/applications/data-management-planner/settings/content/index.rst diff --git a/docs/applications/data-management-planner/administration/settings/content/knowledge-models.rst b/docs/applications/data-management-planner/settings/content/knowledge-models.rst similarity index 100% rename from docs/applications/data-management-planner/administration/settings/content/knowledge-models.rst rename to docs/applications/data-management-planner/settings/content/knowledge-models.rst diff --git a/docs/applications/data-management-planner/administration/settings/content/projects.rst b/docs/applications/data-management-planner/settings/content/projects.rst similarity index 100% rename from docs/applications/data-management-planner/administration/settings/content/projects.rst rename to docs/applications/data-management-planner/settings/content/projects.rst diff --git a/docs/applications/data-management-planner/administration/settings/index.rst b/docs/applications/data-management-planner/settings/index.rst similarity index 94% rename from docs/applications/data-management-planner/administration/settings/index.rst rename to docs/applications/data-management-planner/settings/index.rst index 0f03c251..75a78ded 100644 --- a/docs/applications/data-management-planner/administration/settings/index.rst +++ b/docs/applications/data-management-planner/settings/index.rst @@ -17,6 +17,7 @@ This section covers different settings available to admin users. The settings ar .. toctree:: :maxdepth: 2 + System User Interface Content Info \ No newline at end of file diff --git a/docs/applications/data-management-planner/administration/settings/info/index.rst b/docs/applications/data-management-planner/settings/info/index.rst similarity index 100% rename from docs/applications/data-management-planner/administration/settings/info/index.rst rename to docs/applications/data-management-planner/settings/info/index.rst diff --git a/docs/applications/data-management-planner/administration/settings/info/usage.rst b/docs/applications/data-management-planner/settings/info/usage.rst similarity index 100% rename from docs/applications/data-management-planner/administration/settings/info/usage.rst rename to docs/applications/data-management-planner/settings/info/usage.rst diff --git a/docs/applications/data-management-planner/settings/info/usage/usage.png b/docs/applications/data-management-planner/settings/info/usage/usage.png new file mode 100644 index 00000000..1d12a295 Binary files /dev/null and b/docs/applications/data-management-planner/settings/info/usage/usage.png differ diff --git a/docs/applications/data-management-planner/settings/system/index.rst b/docs/applications/data-management-planner/settings/system/index.rst new file mode 100644 index 00000000..98b7179b --- /dev/null +++ b/docs/applications/data-management-planner/settings/system/index.rst @@ -0,0 +1,15 @@ +System +****** + +The system section of settings for now allows us to toggle and configure plugins. + +---- + +.. raw:: html + +

Table of Contents

+ +.. toctree:: + :maxdepth: 2 + + Plugins diff --git a/docs/applications/data-management-planner/settings/system/plugins.rst b/docs/applications/data-management-planner/settings/system/plugins.rst new file mode 100644 index 00000000..073a8b83 --- /dev/null +++ b/docs/applications/data-management-planner/settings/system/plugins.rst @@ -0,0 +1,13 @@ +.. _plugins: + +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. \ No newline at end of file diff --git a/docs/applications/data-management-planner/settings/system/plugins/plugins.png b/docs/applications/data-management-planner/settings/system/plugins/plugins.png new file mode 100644 index 00000000..ef50f597 Binary files /dev/null and b/docs/applications/data-management-planner/settings/system/plugins/plugins.png differ diff --git a/docs/applications/data-management-planner/administration/settings/user-interface/dashboard.rst b/docs/applications/data-management-planner/settings/user-interface/dashboard.rst similarity index 100% rename from docs/applications/data-management-planner/administration/settings/user-interface/dashboard.rst rename to docs/applications/data-management-planner/settings/user-interface/dashboard.rst diff --git a/docs/applications/data-management-planner/administration/settings/user-interface/index.rst b/docs/applications/data-management-planner/settings/user-interface/index.rst similarity index 100% rename from docs/applications/data-management-planner/administration/settings/user-interface/index.rst rename to docs/applications/data-management-planner/settings/user-interface/index.rst diff --git a/docs/applications/data-management-planner/administration/settings/user-interface/menu.rst b/docs/applications/data-management-planner/settings/user-interface/menu.rst similarity index 100% rename from docs/applications/data-management-planner/administration/settings/user-interface/menu.rst rename to docs/applications/data-management-planner/settings/user-interface/menu.rst diff --git a/docs/applications/data-management-planner/settings/user-interface/menu/custom-links.png b/docs/applications/data-management-planner/settings/user-interface/menu/custom-links.png new file mode 100644 index 00000000..25f6a38f Binary files /dev/null and b/docs/applications/data-management-planner/settings/user-interface/menu/custom-links.png differ diff --git a/docs/applications/integration-hub/profile/about.rst b/docs/applications/integration-hub/profile/about.rst index e9d820d9..b4cb97b3 100644 --- a/docs/applications/integration-hub/profile/about.rst +++ b/docs/applications/integration-hub/profile/about.rst @@ -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. diff --git a/docs/applications/integration-hub/profile/about/modal.png b/docs/applications/integration-hub/profile/about/modal.png index 9084f437..aa028e9d 100644 Binary files a/docs/applications/integration-hub/profile/about/modal.png and b/docs/applications/integration-hub/profile/about/modal.png differ diff --git a/docs/conf.py b/docs/conf.py index 926d0bf7..f9394a99 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = 'FAIR Wizard' -copyright = '2020 - 2025, FAIR Wizard Team' +copyright = '2020 - 2026, FAIR Wizard Team' author = 'FAIR Wizard Team' project_name = 'FAIR Wizard' @@ -26,7 +26,7 @@ registry_name = 'FAIR Wizard Registry' # The full version, including alpha/beta/rc tags -version = release = '4.26' +version = release = '4.28' rst_prolog = f""" diff --git a/docs/index.rst b/docs/index.rst index 989cfb79..f6f2eaf5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 `__ where you can ask questions, share your experience, and get help from other users and administrators. + .. youtube:: dRiWyimAQMA :width: 100% :align: center @@ -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` @@ -84,11 +86,8 @@ 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 `__ - * - - - :ref:`importers` - - .. raw:: html diff --git a/docs/more/development/importers.rst b/docs/more/development/importers.rst deleted file mode 100644 index b9ba5dd1..00000000 --- a/docs/more/development/importers.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _development-importers: - -Project Importers Development -***************************** - -.. WARNING:: - - Project importers are an experimental feature. - -Project importers can be used to import the data from an external resource to |project_name| questionnaire. The importer creates the replies based on the data, therefore it needs to know the structure of the knowledge model it is compatible with. - -FAIR Wizard comes with two importers already implemented. - -- Replies Importer -- maDMP Importer - -.. NOTE:: - - More importers can be added in the future. Please `contact the development team `__ if you are interested in adding a new importer. diff --git a/docs/more/development/index.rst b/docs/more/development/index.rst index 2bcb22b1..dd891c71 100644 --- a/docs/more/development/index.rst +++ b/docs/more/development/index.rst @@ -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` and :ref:`project importers` can be implemented to get data from outside to |project_name|, or new :ref:`document templates` and :ref:`submission services` 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` or new :ref:`document templates` and :ref:`submission services` 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. @@ -19,6 +19,5 @@ This section provides information on how to develop custom content for |project_ metamodel-schemas Document Templates integration-questions/index - Project Importers submission-service Integration via API diff --git a/docs/more/development/integration-questions/index.rst b/docs/more/development/integration-questions/index.rst index 13e9fa91..a68ce66c 100644 --- a/docs/more/development/integration-questions/index.rst +++ b/docs/more/development/integration-questions/index.rst @@ -1,4 +1,4 @@ -.. _integration_questions: +.. _integration-questions: Integration Questions ********************* diff --git a/docs/more/development/submission-service.rst b/docs/more/development/submission-service.rst index 1bf1ea56..f23836b2 100644 --- a/docs/more/development/submission-service.rst +++ b/docs/more/development/submission-service.rst @@ -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.