diff --git a/docs/application/administration/locales/detail/detail.png b/docs/application/administration/locales/detail/detail.png index ff2824f..18dd678 100644 Binary files a/docs/application/administration/locales/detail/detail.png and b/docs/application/administration/locales/detail/detail.png differ diff --git a/docs/application/administration/locales/index/list.png b/docs/application/administration/locales/index/list.png index c6ed4e8..e2d0440 100644 Binary files a/docs/application/administration/locales/index/list.png and b/docs/application/administration/locales/index/list.png differ diff --git a/docs/application/administration/settings/info/usage/usage.png b/docs/application/administration/settings/info/usage/usage.png index 416e582..324b1d9 100644 Binary files a/docs/application/administration/settings/info/usage/usage.png and b/docs/application/administration/settings/info/usage/usage.png differ diff --git a/docs/application/administration/users/create.rst b/docs/application/administration/users/create.rst index 6274f34..33fd102 100644 --- a/docs/application/administration/users/create.rst +++ b/docs/application/administration/users/create.rst @@ -3,7 +3,7 @@ Create User *********** -As administrators, we can create new users manually by clicking :guilabel:`Create` on the :ref:`users list` and submitting the form. Each user must have a unique email address, first name and last name, assigned :ref:`role`, and a password. Optionally, a user can have affiliation specified. +As admins, we can create new users manually by clicking :guilabel:`Create` on the :ref:`users list` and submitting the form. Each user must have a unique email address, first name and last name, assigned :ref:`role`, and a password. Optionally, a user can have affiliation specified. .. figure:: create/create.png :width: 500 diff --git a/docs/application/administration/users/detail.rst b/docs/application/administration/users/detail.rst index 5eb8fab..91df389 100644 --- a/docs/application/administration/users/detail.rst +++ b/docs/application/administration/users/detail.rst @@ -3,7 +3,7 @@ User Detail *********** -As administrators, we can edit existing users manually on the detail (selected user from the :ref:`users list`). It is possible to change all properties of the user, including possibility to change whether the user account is active or inactive. +As admins, we can edit existing users manually on the detail (selected user from the :ref:`users list`). It is possible to change all properties of the user, including possibility to change whether the user account is active or inactive. .. figure:: detail/profile.png diff --git a/docs/application/administration/users/index.rst b/docs/application/administration/users/index.rst index 7a90ead..5a51fc9 100644 --- a/docs/application/administration/users/index.rst +++ b/docs/application/administration/users/index.rst @@ -3,7 +3,7 @@ Users ***** -Users list allows administrators to see and manage all users in a |project_name| instance. The list can be filtered using role, searched based using name or email fragment, and sorted via various properties of users. The list shows the role of a user next to its name and also indicates in case the user is inactive. Next to the email, we can quickly see what authentication services the user uses to log-in (:guilabel:`internal` is the internal authentication with email-password credentials, other are based on configured :ref:`OpenID services`). +Users list allows admins to see and manage all users in a |project_name| instance. The list can be filtered using role, searched based using name or email fragment, and sorted via various properties of users. The list shows the role of a user next to its name and also indicates in case the user is inactive. Next to the email, we can quickly see what authentication services the user uses to log-in (:guilabel:`internal` is the internal authentication with email-password credentials, other are based on configured :ref:`OpenID services`). A :ref:`user detail` can be opened by clicking the name of a user or by selecting :guilabel:`Edit` in the right dropdown menu for the desired row. There, a user can be also deleted via the :guilabel:`Delete` action. Finally, administrator can :ref:`create a new user` by clicking :guilabel:`Create`. diff --git a/docs/application/administration/users/index/list.png b/docs/application/administration/users/index/list.png index ac3c7a1..4e333f4 100644 Binary files a/docs/application/administration/users/index/list.png and b/docs/application/administration/users/index/list.png differ diff --git a/docs/application/document-templates/editors/detail/files/files.png b/docs/application/document-templates/editors/detail/files/files.png index 161cf72..7e3d5fd 100644 Binary files a/docs/application/document-templates/editors/detail/files/files.png and b/docs/application/document-templates/editors/detail/files/files.png differ diff --git a/docs/application/document-templates/editors/detail/index/editor.png b/docs/application/document-templates/editors/detail/index/editor.png index f70fab5..69fb976 100644 Binary files a/docs/application/document-templates/editors/detail/index/editor.png and b/docs/application/document-templates/editors/detail/index/editor.png differ diff --git a/docs/application/document-templates/editors/detail/preview/preview.png b/docs/application/document-templates/editors/detail/preview/preview.png index dd9b110..1eb3938 100644 Binary files a/docs/application/document-templates/editors/detail/preview/preview.png and b/docs/application/document-templates/editors/detail/preview/preview.png differ diff --git a/docs/application/document-templates/editors/detail/template/formats.png b/docs/application/document-templates/editors/detail/template/formats.png index 1a5710e..9256ab8 100644 Binary files a/docs/application/document-templates/editors/detail/template/formats.png and b/docs/application/document-templates/editors/detail/template/formats.png differ diff --git a/docs/application/document-templates/editors/index/list.png b/docs/application/document-templates/editors/index/list.png index be2c7a1..d009c89 100644 Binary files a/docs/application/document-templates/editors/index/list.png and b/docs/application/document-templates/editors/index/list.png differ diff --git a/docs/application/document-templates/list/detail/detail.png b/docs/application/document-templates/list/detail/detail.png index 24de3e4..c0e793a 100644 Binary files a/docs/application/document-templates/list/detail/detail.png and b/docs/application/document-templates/list/detail/detail.png differ diff --git a/docs/application/document-templates/list/index/list.png b/docs/application/document-templates/list/index/list.png index c2870b8..ad77a91 100644 Binary files a/docs/application/document-templates/list/index/list.png and b/docs/application/document-templates/list/index/list.png differ diff --git a/docs/application/documents/index/list.png b/docs/application/documents/index/list.png deleted file mode 100644 index 15fc6fb..0000000 Binary files a/docs/application/documents/index/list.png and /dev/null differ diff --git a/docs/application/knowledge-models/list/detail/detail.png b/docs/application/knowledge-models/list/detail/detail.png index 851c67e..94929b7 100644 Binary files a/docs/application/knowledge-models/list/detail/detail.png and b/docs/application/knowledge-models/list/detail/detail.png differ diff --git a/docs/application/knowledge-models/list/index/list.png b/docs/application/knowledge-models/list/index/list.png index 5b55c6a..8d314df 100644 Binary files a/docs/application/knowledge-models/list/index/list.png and b/docs/application/knowledge-models/list/index/list.png differ diff --git a/docs/application/knowledge-models/list/preview.rst b/docs/application/knowledge-models/list/preview.rst index 90f2cfb..5c7f258 100644 --- a/docs/application/knowledge-models/list/preview.rst +++ b/docs/application/knowledge-models/list/preview.rst @@ -9,6 +9,6 @@ The preview feature for knowledge models allows us to check the content, i.e. ho https://researchers.ds-wizard.org/knowledge-models/dsw:root:2.4.4/preview?questionUuid=0b12fb8c-ee0f-40c0-9c53-b6826b786a0c -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 administrators 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:`../../administration/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`. diff --git a/docs/application/profile/about/modal.png b/docs/application/profile/about/modal.png index 6feb205..dbd2e67 100644 Binary files a/docs/application/profile/about/modal.png and b/docs/application/profile/about/modal.png differ diff --git a/docs/application/profile/assigned-comments/list.png b/docs/application/profile/assigned-comments/list.png index 1265018..2166564 100644 Binary files a/docs/application/profile/assigned-comments/list.png and b/docs/application/profile/assigned-comments/list.png differ diff --git a/docs/application/profile/edit/active-sessions/form.png b/docs/application/profile/edit/active-sessions/form.png index 0fb850c..1d205a1 100644 Binary files a/docs/application/profile/edit/active-sessions/form.png and b/docs/application/profile/edit/active-sessions/form.png differ diff --git a/docs/application/documents/index.rst b/docs/application/projects/documents.rst similarity index 71% rename from docs/application/documents/index.rst rename to docs/application/projects/documents.rst index cdd7f10..2bf5455 100644 --- a/docs/application/documents/index.rst +++ b/docs/application/projects/documents.rst @@ -1,13 +1,13 @@ Documents ********* -As admins, we can quickly browse all documents stored in the |project_name| instance by navigating to :guilabel:`Documents` from the main menu. It is possible to search for a document by name or sort them using the name or creation timestamp. +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. -Each document has a name, format, specific size (if the generation is completed), a link to the project it was generated from, and a template used for its creation. The document can be directly downloaded or deleted from the list. Additionally, we can quickly navigate to the project from which the document was created. +Each document has a name, format, specific size (if the generation is completed), a link to the project it was generated from, and a template used for its creation. The document can be directly downloaded or deleted from the list. In case that there is a document that was not generated due to an error, we can check the error message. Also, if there are some documents got stuck in :guilabel:`Queued` or :guilabel:`In Progress` status, we should check the deployment (especially of the document worker component). -.. figure:: index/list.png +.. figure:: documents/documents.png List of all documents across projects. diff --git a/docs/application/projects/documents/documents.png b/docs/application/projects/documents/documents.png new file mode 100644 index 0000000..3e0356c Binary files /dev/null and b/docs/application/projects/documents/documents.png differ diff --git a/docs/application/projects/files.rst b/docs/application/projects/files.rst new file mode 100644 index 0000000..16ef5ea --- /dev/null +++ b/docs/application/projects/files.rst @@ -0,0 +1,16 @@ +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. + +Each file has a name, size, a link to the project it was uploaded to and user who uploaded it. The file can be directly downloaded or deleted from the list. + +.. WARNING:: + + It is not recommended to delete files from the list without informing the project team, as it can lead to confusion among researchers. Admins should always communicate with the project team before deleting files. + + +.. figure:: files/files.png + + List of all files across projects. + diff --git a/docs/application/projects/files/files.png b/docs/application/projects/files/files.png new file mode 100644 index 0000000..e84dbf2 Binary files /dev/null and b/docs/application/projects/files/files.png differ diff --git a/docs/application/projects/importers/importers.png b/docs/application/projects/importers/importers.png index 3b0d83e..d046c0a 100644 Binary files a/docs/application/projects/importers/importers.png and b/docs/application/projects/importers/importers.png differ diff --git a/docs/application/projects/index.rst b/docs/application/projects/index.rst index ee5efec..67985f9 100644 --- a/docs/application/projects/index.rst +++ b/docs/application/projects/index.rst @@ -22,4 +22,6 @@ Projects are mainly used by the researchers. We have the introduction video abou :maxdepth: 2 List + Files + Documents Importers diff --git a/docs/application/projects/list/detail/documents/new.png b/docs/application/projects/list/detail/documents/new.png index cf49cef..649b5a5 100644 Binary files a/docs/application/projects/list/detail/documents/new.png and b/docs/application/projects/list/detail/documents/new.png differ diff --git a/docs/application/projects/list/detail/index/questionnaire.png b/docs/application/projects/list/detail/index/questionnaire.png index 7b1f610..1006a62 100644 Binary files a/docs/application/projects/list/detail/index/questionnaire.png and b/docs/application/projects/list/detail/index/questionnaire.png differ diff --git a/docs/application/projects/list/detail/metrics/metrics.png b/docs/application/projects/list/detail/metrics/metrics.png index 424157e..80383dc 100644 Binary files a/docs/application/projects/list/detail/metrics/metrics.png and b/docs/application/projects/list/detail/metrics/metrics.png differ diff --git a/docs/application/projects/list/detail/preview/document-template-not-set.png b/docs/application/projects/list/detail/preview/document-template-not-set.png index 64b0b44..e1add07 100644 Binary files a/docs/application/projects/list/detail/preview/document-template-not-set.png and b/docs/application/projects/list/detail/preview/document-template-not-set.png differ diff --git a/docs/application/projects/list/detail/preview/download.png b/docs/application/projects/list/detail/preview/download.png index d6fdaf3..396a37e 100644 Binary files a/docs/application/projects/list/detail/preview/download.png and b/docs/application/projects/list/detail/preview/download.png differ diff --git a/docs/application/projects/list/detail/preview/preview-html.png b/docs/application/projects/list/detail/preview/preview-html.png index aa2fb82..22c99ef 100644 Binary files a/docs/application/projects/list/detail/preview/preview-html.png and b/docs/application/projects/list/detail/preview/preview-html.png differ diff --git a/docs/application/projects/list/detail/questionnaire/chapter-list.png b/docs/application/projects/list/detail/questionnaire/chapter-list.png index 673586e..99d9f0e 100644 Binary files a/docs/application/projects/list/detail/questionnaire/chapter-list.png and b/docs/application/projects/list/detail/questionnaire/chapter-list.png differ diff --git a/docs/application/projects/list/detail/questionnaire/comments.png b/docs/application/projects/list/detail/questionnaire/comments.png index a5c09df..257d3ff 100644 Binary files a/docs/application/projects/list/detail/questionnaire/comments.png and b/docs/application/projects/list/detail/questionnaire/comments.png differ diff --git a/docs/application/projects/list/detail/questionnaire/integration-question.png b/docs/application/projects/list/detail/questionnaire/integration-question.png index ab4d066..3b670b2 100644 Binary files a/docs/application/projects/list/detail/questionnaire/integration-question.png and b/docs/application/projects/list/detail/questionnaire/integration-question.png differ diff --git a/docs/application/projects/list/detail/questionnaire/list-of-items-question.png b/docs/application/projects/list/detail/questionnaire/list-of-items-question.png index 01eff35..21cb4b4 100644 Binary files a/docs/application/projects/list/detail/questionnaire/list-of-items-question.png and b/docs/application/projects/list/detail/questionnaire/list-of-items-question.png differ diff --git a/docs/application/projects/list/detail/questionnaire/options-question.png b/docs/application/projects/list/detail/questionnaire/options-question.png index 2405bed..1e8132d 100644 Binary files a/docs/application/projects/list/detail/questionnaire/options-question.png and b/docs/application/projects/list/detail/questionnaire/options-question.png differ diff --git a/docs/application/projects/list/detail/questionnaire/todos.png b/docs/application/projects/list/detail/questionnaire/todos.png index 3a1a820..3593752 100644 Binary files a/docs/application/projects/list/detail/questionnaire/todos.png and b/docs/application/projects/list/detail/questionnaire/todos.png differ diff --git a/docs/application/projects/list/detail/questionnaire/version-history.png b/docs/application/projects/list/detail/questionnaire/version-history.png index af43b6d..5996860 100644 Binary files a/docs/application/projects/list/detail/questionnaire/version-history.png and b/docs/application/projects/list/detail/questionnaire/version-history.png differ diff --git a/docs/application/projects/list/detail/settings/settings.png b/docs/application/projects/list/detail/settings/settings.png index 2509a50..fed297d 100644 Binary files a/docs/application/projects/list/detail/settings/settings.png and b/docs/application/projects/list/detail/settings/settings.png differ diff --git a/docs/application/projects/list/index/project-list.png b/docs/application/projects/list/index/project-list.png index 0dee00e..41b47e6 100644 Binary files a/docs/application/projects/list/index/project-list.png and b/docs/application/projects/list/index/project-list.png differ diff --git a/docs/index.rst b/docs/index.rst index 24034ff..e5a4edb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -49,7 +49,7 @@ Here are some recommended sections where to start based on the role: - Application * - :ref:`projects` - :ref:`knowledge-models` - - :ref:`documents` + - * - - :ref:`document-templates` - :ref:`administration` @@ -85,7 +85,6 @@ Here are some recommended sections where to start based on the role: application/knowledge-models/index application/document-templates/index application/projects/index - application/documents/index application/administration/index application/profile/index diff --git a/docs/more/development/submission-service.rst b/docs/more/development/submission-service.rst index b243fa5..6ef9551 100644 --- a/docs/more/development/submission-service.rst +++ b/docs/more/development/submission-service.rst @@ -3,7 +3,7 @@ Submission Service ****************** -As administrators, we can configure submission services using :doc:`../../application/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:`../../application/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. 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.