diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 18ca964..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,29 +0,0 @@ -# Contributing - -When contributing, please comply with our conventions so the documentation is consistent. - -## reStructuredText Conventions - -### Headings - -Headings should use the following syntax for specific levels: - -```rst -Chapter (page) -************** - -Section -======= - -Subsection ----------- - -Subsubsection -^^^^^^^^^^^^^ - -Paragraph -""""""""" -``` - -Always the number of characters should match length of the text. - diff --git a/README.md b/README.md index cd64a67..988f455 100644 --- a/README.md +++ b/README.md @@ -56,3 +56,28 @@ pip freeze > docs/requirements.txt This project is licensed under the Creative Commons Attribution-ShareAlike (CC BY-SA) - see the [LICENSE](LICENSE) file for more details. + +## reStructuredText Conventions + +### Headings + +Headings should use the following syntax for specific levels: + +```rst +Chapter (page) +************** + +Section +======= + +Subsection +---------- + +Subsubsection +^^^^^^^^^^^^^ + +Paragraph +""""""""" +``` + +Always the number of characters should match length of the text. diff --git a/docs/applications/admin-center/audit-log/index/detail.png b/docs/applications/admin-center/audit-log/index/detail.png index a780160..c5bf6f6 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/audit-log/index/list.png b/docs/applications/admin-center/audit-log/index/list.png index 803de23..9382963 100644 Binary files a/docs/applications/admin-center/audit-log/index/list.png and b/docs/applications/admin-center/audit-log/index/list.png differ diff --git a/docs/applications/admin-center/import/index/index.png b/docs/applications/admin-center/import/index/index.png index 7aa9259..29664ce 100644 Binary files a/docs/applications/admin-center/import/index/index.png and b/docs/applications/admin-center/import/index/index.png differ diff --git a/docs/applications/admin-center/profile/about.rst b/docs/applications/admin-center/profile/about.rst new file mode 100644 index 0000000..9e2f5e8 --- /dev/null +++ b/docs/applications/admin-center/profile/about.rst @@ -0,0 +1,13 @@ +About +***** + +By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with. + +The :guilabel:`API URL` link provides access to the server's API endpoints, which can be used for integrating the Data Stewardship Wizard with other systems and automating tasks. + +The :guilabel:`API Documentation` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters. + +.. figure:: about/modal.png + :width: 500 + + Modal window with versions of the tool's components. diff --git a/docs/applications/admin-center/profile/about/modal.png b/docs/applications/admin-center/profile/about/modal.png new file mode 100644 index 0000000..703e276 Binary files /dev/null and b/docs/applications/admin-center/profile/about/modal.png differ diff --git a/docs/applications/admin-center/profile/edit/active-sessions/form.png b/docs/applications/admin-center/profile/edit/active-sessions/form.png index 89a9ccb..489637a 100644 Binary files a/docs/applications/admin-center/profile/edit/active-sessions/form.png and b/docs/applications/admin-center/profile/edit/active-sessions/form.png differ diff --git a/docs/applications/admin-center/profile/index.rst b/docs/applications/admin-center/profile/index.rst index 159791a..a5b212a 100644 --- a/docs/applications/admin-center/profile/index.rst +++ b/docs/applications/admin-center/profile/index.rst @@ -17,4 +17,5 @@ Moreover, there are also options to :guilabel:`Log out`, see basic information a :maxdepth: 2 Edit Profile + About \ No newline at end of file diff --git a/docs/applications/admin-center/settings/info/usage/table.png b/docs/applications/admin-center/settings/info/usage/table.png index e4187c1..1e04d2d 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/user-groups/detail/members.png b/docs/applications/admin-center/user-groups/detail/members.png index 60f67c3..f6069ac 100644 Binary files a/docs/applications/admin-center/user-groups/detail/members.png and b/docs/applications/admin-center/user-groups/detail/members.png differ diff --git a/docs/applications/admin-center/user-groups/index/list.png b/docs/applications/admin-center/user-groups/index/list.png index f11e8b8..92a9616 100644 Binary files a/docs/applications/admin-center/user-groups/index/list.png and b/docs/applications/admin-center/user-groups/index/list.png differ diff --git a/docs/applications/admin-center/users/index/list.png b/docs/applications/admin-center/users/index/list.png index 615ab8b..23dfe08 100644 Binary files a/docs/applications/admin-center/users/index/list.png and b/docs/applications/admin-center/users/index/list.png differ diff --git a/docs/applications/analytics/index.rst b/docs/applications/analytics/index.rst index 7104ec7..7583a85 100644 --- a/docs/applications/analytics/index.rst +++ b/docs/applications/analytics/index.rst @@ -34,4 +34,5 @@ It is also possible to turn on regular synchronization in settings. This will sy Projects Users User Groups + Profile \ No newline at end of file diff --git a/docs/applications/analytics/knowledge-models.rst b/docs/applications/analytics/knowledge-models.rst index 954ce9d..00015bf 100644 --- a/docs/applications/analytics/knowledge-models.rst +++ b/docs/applications/analytics/knowledge-models.rst @@ -28,4 +28,20 @@ We can also resize all rows height by clicking on the double arrow in the top le Don't forget to click on :guilabel:`Save` icon after you are done with editing the view. +By clicking on the Knowledge Model id or name, we can open that Knowledge Model detail. If we choose to click on a certain version of a Knowledge Model, that versions detail will open. + +The Knowledge Model details have four tabs. The :guilabel:`Readme` tab shows the exact information that we can see in the Knowledge Model Detail within the Data Management Planner. The :guilabel:`Projects` tab shows all Projects that are using the selected Knowledge Model. The :guilabel:`KM Editors` tab shows all Knowledge Model Editors that are using the selected Knowledge Model. Both of these tabs also display numbers next to them, representing the number of created Projects or Knowledge Model Editors. + + .. figure:: knowledge-models/km-editors.png + + Knowledge Model Editors created using this Knowledge Model. + +The last tab, :guilabel:`Insights`, is the most complex. It shows us detailed information for each question and answer, such as the number of times a certain question was displayed to users and how these questions were answered. + +Furthermore, we can also open various questions to see insights into how the Researchers are answering them. + + .. figure:: knowledge-models/insights.png + + Insights to usage of this Knowledge Model in Projects. + The data of a view can be exported to a CSV file by clicking on :guilabel:`Export CSV`. diff --git a/docs/applications/analytics/knowledge-models/Insights.png b/docs/applications/analytics/knowledge-models/Insights.png new file mode 100644 index 0000000..099d337 Binary files /dev/null and b/docs/applications/analytics/knowledge-models/Insights.png differ diff --git a/docs/applications/analytics/knowledge-models/insights.png b/docs/applications/analytics/knowledge-models/insights.png new file mode 100644 index 0000000..099d337 Binary files /dev/null and b/docs/applications/analytics/knowledge-models/insights.png differ diff --git a/docs/applications/analytics/knowledge-models/km-editors.png b/docs/applications/analytics/knowledge-models/km-editors.png new file mode 100644 index 0000000..0c7efb0 Binary files /dev/null and b/docs/applications/analytics/knowledge-models/km-editors.png differ diff --git a/docs/applications/analytics/knowledge-models/overview.png b/docs/applications/analytics/knowledge-models/overview.png index 1058709..d5f6519 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/knowledge-models/settings.png b/docs/applications/analytics/knowledge-models/settings.png index 462e4cf..7117ccb 100644 Binary files a/docs/applications/analytics/knowledge-models/settings.png and b/docs/applications/analytics/knowledge-models/settings.png differ diff --git a/docs/applications/analytics/profile/about.rst b/docs/applications/analytics/profile/about.rst new file mode 100644 index 0000000..b5f9162 --- /dev/null +++ b/docs/applications/analytics/profile/about.rst @@ -0,0 +1,13 @@ +About +***** + +By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with. + +The :guilabel:`API URL` link provides access to the server's API endpoints, which can be used for integrating the Data Stewardship Wizard with other systems and automating tasks. + +The :guilabel:`API Documentation` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters. + +.. figure:: about/modal.png + :width: 500 + + Modal window with versions of the tool's components. diff --git a/docs/applications/analytics/profile/about/modal.png b/docs/applications/analytics/profile/about/modal.png new file mode 100644 index 0000000..274c71e Binary files /dev/null and b/docs/applications/analytics/profile/about/modal.png differ diff --git a/docs/applications/analytics/profile/edit.rst b/docs/applications/analytics/profile/edit.rst new file mode 100644 index 0000000..d6ca02c --- /dev/null +++ b/docs/applications/analytics/profile/edit.rst @@ -0,0 +1,8 @@ +Edit +**** + +After navigating to :guilabel:`Edit profile` from the :doc:`../index` menu, we open the User Settings. We can view our **Email** address, **First name**, **Last name**, and **Affiliation**. + +We can see API Keys we have generated. + +We can also see Active Sessions and revoke them if needed. diff --git a/docs/applications/analytics/profile/index.rst b/docs/applications/analytics/profile/index.rst new file mode 100644 index 0000000..61c8473 --- /dev/null +++ b/docs/applications/analytics/profile/index.rst @@ -0,0 +1,21 @@ +Profile +******* + +As every logged-in user, we can manage our own profile. We can see the options by hovering over the box with our name and avatar in the lower part of the left sidebar with main menu (only avatar is shown in case of collapsed sidebar). From there, we can navigate to :doc:`./edit`. + +Moreover, there are also options to :guilabel:`Log out`, see basic information about the |project_name| using :guilabel:`About`, or in case of problems we can use :guilabel:`Report issue` to know how to proceed. + + +---- + +.. raw:: html + +

Table of Contents

+ + +.. toctree:: + :maxdepth: 2 + + Edit Profile + About + \ No newline at end of file diff --git a/docs/applications/analytics/projects/overview.png b/docs/applications/analytics/projects/overview.png index 753850c..66c67ee 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/user-groups/detail.png b/docs/applications/analytics/user-groups/detail.png index b3e13e5..b002bcf 100644 Binary files a/docs/applications/analytics/user-groups/detail.png and b/docs/applications/analytics/user-groups/detail.png differ diff --git a/docs/applications/analytics/user-groups/overview.png b/docs/applications/analytics/user-groups/overview.png index dc80b37..ef9f106 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/users/detail.png b/docs/applications/analytics/users/detail.png index c3e97e6..dc4608e 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 6e19128..564bfe9 100644 Binary files a/docs/applications/analytics/users/overview.png and b/docs/applications/analytics/users/overview.png differ diff --git a/docs/applications/data-management-planner/administration/locales/detail/detail.png b/docs/applications/data-management-planner/administration/locales/detail/detail.png index 43d1668..5174e37 100644 Binary files a/docs/applications/data-management-planner/administration/locales/detail/detail.png and b/docs/applications/data-management-planner/administration/locales/detail/detail.png differ diff --git a/docs/applications/data-management-planner/administration/locales/index/list.png b/docs/applications/data-management-planner/administration/locales/index/list.png index f7550fb..0434113 100644 Binary files a/docs/applications/data-management-planner/administration/locales/index/list.png and b/docs/applications/data-management-planner/administration/locales/index/list.png differ 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 index 172bdbd..5637057 100644 Binary files a/docs/applications/data-management-planner/administration/settings/info/usage/usage.png and b/docs/applications/data-management-planner/administration/settings/info/usage/usage.png differ diff --git a/docs/applications/data-management-planner/administration/settings/user-interface/dashboard.rst b/docs/applications/data-management-planner/administration/settings/user-interface/dashboard.rst index 3b99a42..a595692 100644 --- a/docs/applications/data-management-planner/administration/settings/user-interface/dashboard.rst +++ b/docs/applications/data-management-planner/administration/settings/user-interface/dashboard.rst @@ -29,16 +29,3 @@ We can select the **Dashboard Style** whether the user should see a standard **w * **Usage Widget** summarizes the usage just as is also possible to see in the :doc:`../info/usage`. * **Configure Organization Widget** quickly navigates to :doc:`../system/organization` if it is not yet done. - -.. _announcements: - -Announcements -============= - -Another option to adjust the dashboard and/or the login screen is to add Announcements. Announcements are displayed above the main content in the login screen. In dashboard, they are also displayed above the main content for both **welcome** and **role-based** dashboard style. There are three levels of Announcements: - -* **Info** - light blue color for sending information to the users. -* **Warning** - yellow to warn the users about something. -* **Critical** - red to signalize the Announcement is critical and it needs attention. - -The content of the Announcement can be edited using Markdown. There are also two additional switches which determine, where the Announcement is displayed. The Announcement can be set up to be displayed either on the dashboard after users log in or on the login screen before the users log in. It is also possible to display the same Announcement in both places. Number of Announcements is not limited. diff --git a/docs/applications/data-management-planner/administration/settings/user-interface/index.rst b/docs/applications/data-management-planner/administration/settings/user-interface/index.rst index 9ca6e01..22944b0 100644 --- a/docs/applications/data-management-planner/administration/settings/user-interface/index.rst +++ b/docs/applications/data-management-planner/administration/settings/user-interface/index.rst @@ -1,7 +1,7 @@ User Interface Settings *********************** -User Interface (UI) settings allow us to manage how the Data Management Planner app looks like: dashboard shown when user logs in, announcements and custom menu links. +User Interface (UI) settings allow us to manage how the Data Management Planner app looks like: dashboard shown when user logs in and custom menu links. ---- diff --git a/docs/applications/data-management-planner/document-templates/editors/detail/files/files.png b/docs/applications/data-management-planner/document-templates/editors/detail/files/files.png index 9550c41..2f87fee 100644 Binary files a/docs/applications/data-management-planner/document-templates/editors/detail/files/files.png and b/docs/applications/data-management-planner/document-templates/editors/detail/files/files.png differ diff --git a/docs/applications/data-management-planner/document-templates/editors/detail/index/editor.png b/docs/applications/data-management-planner/document-templates/editors/detail/index/editor.png index c5f3539..a406dc8 100644 Binary files a/docs/applications/data-management-planner/document-templates/editors/detail/index/editor.png and b/docs/applications/data-management-planner/document-templates/editors/detail/index/editor.png differ diff --git a/docs/applications/data-management-planner/document-templates/editors/index/list.png b/docs/applications/data-management-planner/document-templates/editors/index/list.png index 36eb879..63adab7 100644 Binary files a/docs/applications/data-management-planner/document-templates/editors/index/list.png and b/docs/applications/data-management-planner/document-templates/editors/index/list.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 738c915..624402d 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 863c6ff..e30f4a1 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/documents/index/list.png b/docs/applications/data-management-planner/documents/index/list.png index c7d18dd..93e407a 100644 Binary files a/docs/applications/data-management-planner/documents/index/list.png and b/docs/applications/data-management-planner/documents/index/list.png differ diff --git a/docs/applications/data-management-planner/knowledge-models/editors/detail/index/km-editor.png b/docs/applications/data-management-planner/knowledge-models/editors/detail/index/km-editor.png index 5fe8769..1488ebc 100644 Binary files a/docs/applications/data-management-planner/knowledge-models/editors/detail/index/km-editor.png and b/docs/applications/data-management-planner/knowledge-models/editors/detail/index/km-editor.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 c0eec44..0fe6229 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/editors/migration/migration.png b/docs/applications/data-management-planner/knowledge-models/editors/migration/migration.png index b95717a..b138752 100644 Binary files a/docs/applications/data-management-planner/knowledge-models/editors/migration/migration.png and b/docs/applications/data-management-planner/knowledge-models/editors/migration/migration.png differ 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 7c84687..688b22b 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 4c5acde..3546927 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/profile/about.rst b/docs/applications/data-management-planner/profile/about.rst new file mode 100644 index 0000000..bc55d1b --- /dev/null +++ b/docs/applications/data-management-planner/profile/about.rst @@ -0,0 +1,15 @@ +.. _planner-about: + +About +***** + +By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with. + +The :guilabel:`API URL` link provides access to the server's API endpoints, which can be used for integrating the Data Stewardship Wizard with other systems and automating tasks. + +The :guilabel:`API Documentation` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters. + +.. figure:: about/modal.png + :width: 500 + + Modal window with versions of the tool's components. diff --git a/docs/applications/data-management-planner/profile/about/modal.png b/docs/applications/data-management-planner/profile/about/modal.png new file mode 100644 index 0000000..f4b9de0 Binary files /dev/null and b/docs/applications/data-management-planner/profile/about/modal.png differ diff --git a/docs/applications/data-management-planner/profile/assigned-comments.rst b/docs/applications/data-management-planner/profile/assigned-comments.rst new file mode 100644 index 0000000..2719dd1 --- /dev/null +++ b/docs/applications/data-management-planner/profile/assigned-comments.rst @@ -0,0 +1,10 @@ +.. _assigned-comments: + +Assigned Comments +***************** + +In the profile menu, we can view comments assigned to us. By clicking on the link, we can open the list of assigned comments. We can then filter assigned comments by resolved or unresolved. We can also order the assigned comments by project and date added. + +.. figure:: assigned-comments/list.png + + List of comments assigned to a user. diff --git a/docs/applications/data-management-planner/profile/assigned-comments/list.png b/docs/applications/data-management-planner/profile/assigned-comments/list.png new file mode 100644 index 0000000..1790456 Binary files /dev/null and b/docs/applications/data-management-planner/profile/assigned-comments/list.png differ diff --git a/docs/applications/data-management-planner/profile/edit/active-sessions/form.png b/docs/applications/data-management-planner/profile/edit/active-sessions/form.png index 91c3c68..c6e1f8e 100644 Binary files a/docs/applications/data-management-planner/profile/edit/active-sessions/form.png and b/docs/applications/data-management-planner/profile/edit/active-sessions/form.png differ diff --git a/docs/applications/data-management-planner/profile/index.rst b/docs/applications/data-management-planner/profile/index.rst index 93c1c54..6e4a2f1 100644 --- a/docs/applications/data-management-planner/profile/index.rst +++ b/docs/applications/data-management-planner/profile/index.rst @@ -1,7 +1,9 @@ +.. _planner-profile: + Profile ******* -As every logged-in user, we can manage our own profile. We can see the options by hovering over the box with our name and avatar in the lower part of the left sidebar with main menu (only avatar is shown in case of collapsed sidebar). From there, we can navigate to :doc:`./edit/index`. If locales are configured, we can also :doc:`./language`. +As every logged-in user, we can manage our own profile. We can see the options by hovering over the box with our name and avatar in the lower part of the left sidebar with main menu (only avatar is shown in case of collapsed sidebar). From there, we can navigate to :doc:`./edit/index`. If locales are configured, we can also :doc:`./language`. We can view our :doc:`./assigned-comments` through the profile menu. Moreover, there are also options to :guilabel:`Log out`, see basic information about the |project_name| using :guilabel:`About`, or in case of problems we can use :guilabel:`Report issue` to know how to proceed. @@ -23,5 +25,7 @@ Moreover, there are also options to :guilabel:`Log out`, see basic information a :maxdepth: 2 Edit Profile + Assigned Comments Change Language + About \ No newline at end of file diff --git a/docs/applications/data-management-planner/profile/index/menu.png b/docs/applications/data-management-planner/profile/index/menu.png index bf953fb..198a639 100644 Binary files a/docs/applications/data-management-planner/profile/index/menu.png and b/docs/applications/data-management-planner/profile/index/menu.png differ diff --git a/docs/applications/data-management-planner/projects/list/create/project-create-custom.png b/docs/applications/data-management-planner/projects/list/create/project-create-custom.png index d570070..ae73d9c 100644 Binary files a/docs/applications/data-management-planner/projects/list/create/project-create-custom.png and b/docs/applications/data-management-planner/projects/list/create/project-create-custom.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 e7b380a..5ed77da 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 4560744..2ca052c 100644 --- a/docs/applications/data-management-planner/projects/list/detail/questionnaire.rst +++ b/docs/applications/data-management-planner/projects/list/detail/questionnaire.rst @@ -38,7 +38,6 @@ There are three desirability states the question can be in: If there is no phase defined on the knowledge model, the current phase selection is not visible in the questionnaire detail. - Chapters ======== @@ -51,6 +50,7 @@ For the opened chapter, we can see a navigation tree for the chapter structure, Chapter list showing the also the questions for the opened chapter. + Questionnaire Area ================== @@ -108,6 +108,7 @@ There is a trash bin icon in the item's top right corner that we can use to **de List of items question with a single item. + Value Question -------------- @@ -132,7 +133,6 @@ When we pick an answer from the list, we not only have the answer but also **a l Integration question with a response from FAIRsharing containing also a link. - Multi-Choice Question --------------------- @@ -192,6 +192,7 @@ We sometimes want to leave comments to discuss things with our team or just remi Example of a comment. + .. _add-comment: Add Comment @@ -199,6 +200,7 @@ Add Comment To add a comment, we need to click on the comments icon by the question which opens a side panel with all the comments related to that question. Then, we can write the comment into the text box and submit. + View Comments ------------- @@ -207,6 +209,14 @@ When there are any comments for a question, the comments icon is changed. It has In the questionnaire menu bar, there is also a :guilabel:`Comments` tab, showing a badge with the number of comments everywhere in the questionnaire. If we open the tab, we can see a list of questions for each chapter where there are some comments. Clicking on the question there will bring us to that question and open the comments side panel. +Assign Comments +--------------- + +We can assign comments to a specific user. This is useful when we want to ask someone to reply or when we want to assign a task to someone. We can assign a comment by clicking on the :guilabel:`Assign comment thread` button in the comment. We can also see who the comment is assigned to in the comment list. + +When a comments is assigned to a user, they are notified by an email. Comments assigned to us are also visible in the :ref:`profile`. + + Comment Threads --------------- @@ -215,6 +225,16 @@ Comments are organized into comment threads for better clarity. We can either st When the thread is resolved, we can click on the ✔ icon in order to resolve it. Resolved threads can be later viewed by selecting :guilabel:`View resolved comments`. They can also be reopened if needed. +Resolved Comments +----------------- + +When we resolve a comment, it is not deleted but only hidden. We can see all resolved comments by selecting :guilabel:`View resolved comments` from the comments tab. We can also reopen the resolved comment if needed. + +.. note:: + + The :guilabel:`View resolved comments` switch is only present when there is at least one resolved comment in the questionnaire. + + Editor Notes ------------ @@ -246,6 +266,7 @@ When we open the :guilabel:`Version history` tab from the questionnaire menu bar Version history shows all events changing the project. + Name a Version -------------- diff --git a/docs/applications/data-management-planner/projects/list/detail/questionnaire/comments.png b/docs/applications/data-management-planner/projects/list/detail/questionnaire/comments.png index 79a852b..a9ab711 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/questionnaire/comments.png and b/docs/applications/data-management-planner/projects/list/detail/questionnaire/comments.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 597f072..c5e47ef 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/multi-choice-question.png b/docs/applications/data-management-planner/projects/list/detail/questionnaire/multi-choice-question.png index fee1a43..0fc0622 100644 Binary files a/docs/applications/data-management-planner/projects/list/detail/questionnaire/multi-choice-question.png and b/docs/applications/data-management-planner/projects/list/detail/questionnaire/multi-choice-question.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 24befc2..fefa153 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/projects/list/migration/create.png b/docs/applications/data-management-planner/projects/list/migration/create.png index c16729a..96ed553 100644 Binary files a/docs/applications/data-management-planner/projects/list/migration/create.png and b/docs/applications/data-management-planner/projects/list/migration/create.png differ diff --git a/docs/applications/data-management-planner/projects/list/migration/migration.png b/docs/applications/data-management-planner/projects/list/migration/migration.png index 2df724b..64991d7 100644 Binary files a/docs/applications/data-management-planner/projects/list/migration/migration.png and b/docs/applications/data-management-planner/projects/list/migration/migration.png differ diff --git a/docs/applications/integration-hub/index.rst b/docs/applications/integration-hub/index.rst index 145f663..5aeb164 100644 --- a/docs/applications/integration-hub/index.rst +++ b/docs/applications/integration-hub/index.rst @@ -16,4 +16,5 @@ Integration Hub is an application for management of integrations. For now, it of :maxdepth: 2 Value Integrations + Profile \ No newline at end of file diff --git a/docs/applications/integration-hub/profile/about.rst b/docs/applications/integration-hub/profile/about.rst new file mode 100644 index 0000000..ec853b1 --- /dev/null +++ b/docs/applications/integration-hub/profile/about.rst @@ -0,0 +1,15 @@ +.. _about-integration-hub: + +About +***** + +By selecting the :guilabel:`About` option from the :doc:`./index` menu, users are directed to the About page. This page offers detailed information about the current versions and build timestamps of the tool's components. This level of transparency helps ensure that both users and developers are fully informed about the specific versions and build statuses of the components they are working with. + +The :guilabel:`API URL` link provides access to the server's API endpoints, which can be used for integrating the Data Stewardship Wizard with other systems and automating tasks. + +The :guilabel:`API Documentation` link directs to the API documentation presented in Swagger UI that provides detailed descriptions of available operations and parameters. + +.. figure:: about/modal.png + :width: 500 + + Modal window with versions of the tool's components. diff --git a/docs/applications/integration-hub/profile/about/modal.png b/docs/applications/integration-hub/profile/about/modal.png new file mode 100644 index 0000000..7c5c991 Binary files /dev/null and b/docs/applications/integration-hub/profile/about/modal.png differ diff --git a/docs/applications/integration-hub/profile/edit.rst b/docs/applications/integration-hub/profile/edit.rst new file mode 100644 index 0000000..d6ca02c --- /dev/null +++ b/docs/applications/integration-hub/profile/edit.rst @@ -0,0 +1,8 @@ +Edit +**** + +After navigating to :guilabel:`Edit profile` from the :doc:`../index` menu, we open the User Settings. We can view our **Email** address, **First name**, **Last name**, and **Affiliation**. + +We can see API Keys we have generated. + +We can also see Active Sessions and revoke them if needed. diff --git a/docs/applications/integration-hub/profile/index.rst b/docs/applications/integration-hub/profile/index.rst new file mode 100644 index 0000000..9a3e2df --- /dev/null +++ b/docs/applications/integration-hub/profile/index.rst @@ -0,0 +1,20 @@ +Profile +******* + +As every logged-in user, we can manage our own profile. We can see the options by hovering over the box with our name and avatar in the lower part of the left sidebar with main menu (only avatar is shown in case of collapsed sidebar). From there, we can navigate to :doc:`./edit`. + +Moreover, there are also options to :guilabel:`Log out`, see basic information about the |project_name| using :guilabel:`About`, or in case of problems we can use :guilabel:`Report issue` to know how to proceed. + + +---- + +.. raw:: html + +

Table of Contents

+ + +.. toctree:: + :maxdepth: 2 + + Edit Profile + About diff --git a/docs/applications/integration-hub/value-integrations/index/list.png b/docs/applications/integration-hub/value-integrations/index/list.png index 28e6e72..8681d9c 100644 Binary files a/docs/applications/integration-hub/value-integrations/index/list.png and b/docs/applications/integration-hub/value-integrations/index/list.png differ diff --git a/docs/conf.py b/docs/conf.py index 6899bd9..65b4848 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,7 +26,7 @@ registry_name = 'FAIR Wizard Registry' # The full version, including alpha/beta/rc tags -version = release = '4.8' +version = release = '4.9' rst_prolog = f""" @@ -96,6 +96,7 @@ def setup(app): app.add_css_file('style.css') + app.add_js_file('https://js-eu1.hs-scripts.com/26982596.js') suppress_warnings = [ # Suppress "WARNING: unknown mimetype (issue with .ico) diff --git a/docs/more/development/api.rst b/docs/more/development/api.rst new file mode 100644 index 0000000..f54423c --- /dev/null +++ b/docs/more/development/api.rst @@ -0,0 +1,37 @@ +******************* +Integration via API +******************* + +An Application Programming Interface (API) allows machines, such as other systems and tools, to perform actions and transfer data based on agreed-upon methods. + +By selecting the :guilabel:`About` option from the :ref:`Profile` menu, users are directed to the :ref:`About` page where the :guilabel:`API URL` and :guilabel:`API Docs` are provided. The SwaggerUI API Documentation and OpenAPI Specifications allows you to explore all operations and data transfer and also you to directly try out the API calls, with example responses provided for guidance. In this way, you can reach Wizard API; however, in Admin Center, Analytics, and Integration Hub, you can reach the :guilabel:`API URL` and :guilabel:`API Docs` in the same way (via the :guilabel:`About` dialog). + +Authentication and Authorization +================================ + +DSW utilizes JSON Web Tokens (JWT) for both authentication and authorization, ensuring secure access and control over API interactions. To obtain a token, you must have a user account, and there are multiple methods to acquire one: + +* **Credentials** (Email + Password): Send a POST request to /tokens with your email and password. If your credentials are correct and your account is active, you will receive a token along with its expiration time in the response. +* **OpenID Identity Provider** (for our client only): This method involves a more complex OpenID/OAuth flow, utilizing redirects with the ``/auth/{id}/`` endpoints to authenticate. +* **API Keys**: You can generate an API key in your user profile, which remains valid until its specified expiration date. + +While several public endpoints are accessible without authentication, most endpoints require it. The system will check if you are authorized to perform specific operations based on your :ref:`roles` and their permissions. These roles are defined globally and can also be specific to projects. This ensures that only authorized users can access and manipulate with sensitive resources. + +Example +======= + +After obtaining your authentication token and reviewing the API documentation, you can start making API calls to execute actions and transfer data, easily integrating them into your projects. Here's a simple example using the `Requests library in Python `__: + + +.. code-block:: + + import requests + WIZARD_API_URL = '...' + API_KEY = '...' + response = requests.get( + url=f'{WIZARD_API_URL}/users/current', + headers={'Authorization': f'Bearer {API_KEY}'}, + ) + response.raise_for_status() + user = response.json() + print(f'This API Key belongs to {user["email"]}') diff --git a/docs/more/development/document-templates/tdk.rst b/docs/more/development/document-templates/tdk.rst index 6703ef2..a6ba6c9 100644 --- a/docs/more/development/document-templates/tdk.rst +++ b/docs/more/development/document-templates/tdk.rst @@ -70,8 +70,8 @@ Environment variables and .env file You can use environment variables to authenticate: -* ``DSW_API_URL`` = URL of |project_name| API with which you want to communicate. Hover mouse over your profile name to find the About section where URL is specified. -* ``DSW_API_KEY`` = your API Key. Hover mouse over your profile name, click on :guilabel:`Edit Profile` and then navigate to :guilabel:`API Keys` From there, you can generate a new API Key for the authentication. +* ``DSW_API_URL`` = URL of |project_name| API with which you want to communicate. Hover mouse over your profile name to find the :ref:`About` section where URL is specified. +* ``DSW_API_KEY`` = your :ref:`API Key`. Hover mouse over your profile name, click on :guilabel:`Edit Profile` and then navigate to :guilabel:`API Keys` From there, you can generate a new API Key for the authentication. To make this even easier, you can store those in ``.env`` file in the project root and it will be loaded automatically. Or you can specify the path to a ``.env`` file: diff --git a/docs/more/development/index.rst b/docs/more/development/index.rst index 23bee16..2bcb22b 100644 --- a/docs/more/development/index.rst +++ b/docs/more/development/index.rst @@ -21,3 +21,4 @@ This section provides information on how to develop custom content for |project_ integration-questions/index Project Importers submission-service + Integration via API diff --git a/docs/more/miscellaneous/fw-registry/fw-registry.png b/docs/more/miscellaneous/fw-registry/fw-registry.png index e58b3e9..273e97a 100644 Binary files a/docs/more/miscellaneous/fw-registry/fw-registry.png and b/docs/more/miscellaneous/fw-registry/fw-registry.png differ