Merge pull request #90 from codevence/develop

Preview 4.9

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.

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.

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<edit/index>
+    About<about>
 

docs/applications/analytics/index.rst

@@ -34,4 +34,5 @@ It is also possible to turn on regular synchronization in settings. This will sy
     Projects<projects>
     Users<users>
     User Groups<user-groups>
+    Profile<profile/index>
 

docs/applications/analytics/knowledge-models.rst

@@ -28,4 +28,22 @@ 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
+     :width: 400
+
+     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
+     :width: 400
+
+     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`.

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.

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.

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
+
+    <h2>Table of Contents</h2>
+
+
+.. toctree::
+    :maxdepth: 2
+
+    Edit Profile<edit>
+    About<about>
+

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.

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.
 
 ----
 

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.

docs/applications/data-management-planner/profile/assigned-comments.rst

@@ -0,0 +1,11 @@
+.. _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
+    :width: 500
+
+    List of comments assigned to a user.

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<edit/index>
+    Assigned Comments<assigned-comments>
     Change Language<language>
+    About<about>
 

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,13 +192,15 @@ We sometimes want to leave comments to discuss things with our team or just remi
 
     Example of a comment.
 
+
 .. _add-comment:
 
 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<planner-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
 --------------
 

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<value-integrations/index>
+    Profile<profile/index>
 

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.

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.

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
+
+    <h2>Table of Contents</h2>
+
+
+.. toctree::
+    :maxdepth: 2
+
+    Edit Profile<edit>
+    About<about>

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)