Merge pull request #159 from ds-wizard/release/4.9.0

Release 4.9.0 (develop)
ds-wizard · Aug 5, 2024 · af1a290 · af1a290
2 parents ba9fd18 + 5c54784
commit af1a290
Show file tree

Hide file tree

Showing 46 changed files with 41 additions and 17 deletions.
diff --git a/docs/application/administration/locales/detail/detail.png b/docs/application/administration/locales/detail/detail.png
diff --git a/docs/application/administration/locales/index/list.png b/docs/application/administration/locales/index/list.png
diff --git a/docs/application/administration/settings/info/usage/usage.png b/docs/application/administration/settings/info/usage/usage.png
diff --git a/docs/application/administration/users/create.rst b/docs/application/administration/users/create.rst
@@ -5,9 +5,10 @@ Create User
 
 As administrators, we can create new users manually by clicking :guilabel:`Create` on the :ref:`users list<users-list>` and submitting the form. Each user must have a unique email address, first name and last name, assigned :ref:`role<user-roles>`, and a password. Optionally, a user can have affiliation specified.
 
-.. TODO::
-
-    Add screenshot of user creation form
+.. figure:: create/create.png
+    :width: 500
+
+    User creation form.
 
 
 .. NOTE::

diff --git a/docs/application/administration/users/create/create.png b/docs/application/administration/users/create/create.png
diff --git a/docs/application/administration/users/index/list.png b/docs/application/administration/users/index/list.png
diff --git a/docs/application/document-templates/editors/detail/files/files.png b/docs/application/document-templates/editors/detail/files/files.png
diff --git a/docs/application/document-templates/editors/detail/index/editor.png b/docs/application/document-templates/editors/detail/index/editor.png
diff --git a/docs/application/document-templates/editors/index.rst b/docs/application/document-templates/editors/index.rst
@@ -5,9 +5,9 @@ Document Template Editors
 
 On this page, we can see a list of all document template editors. Everyone with the data steward role assigned can see all the document template editors and use them.
 
-.. TODO::
-
-    figure
+.. figure:: index/list.png
+    
+    List of document template editors with actions.
 
 
 We can use the search field to search for a specific document template editor. The editors are sorted by when they were last updated but we can change that.
@@ -19,12 +19,6 @@ By clicking the triple dots on each of the item in the list we can access some a
 - **Open Editor** - simply open the :doc:`./detail/index` (we can also click the name of the editor)
 - **Delete** - to delete the document template editor (cannot be undone)
 
-
-.. figure:: index/list.png
-
-    List of document template editors with actions.
-
-
 .. raw:: html
 
     <h2>Table of Contents</h2>

diff --git a/docs/application/document-templates/editors/index/list.png b/docs/application/document-templates/editors/index/list.png
diff --git a/docs/application/document-templates/list/detail/detail.png b/docs/application/document-templates/list/detail/detail.png
diff --git a/docs/application/document-templates/list/index/list.png b/docs/application/document-templates/list/index/list.png
diff --git a/docs/application/documents/index/list.png b/docs/application/documents/index/list.png
diff --git a/docs/application/knowledge-models/editors/detail/index/km-editor.png b/docs/application/knowledge-models/editors/detail/index/km-editor.png
diff --git a/docs/application/knowledge-models/editors/index/knowledge-model-editors-list.png b/docs/application/knowledge-models/editors/index/knowledge-model-editors-list.png
diff --git a/docs/application/knowledge-models/editors/migration/migration.png b/docs/application/knowledge-models/editors/migration/migration.png
diff --git a/docs/application/knowledge-models/list/detail/detail.png b/docs/application/knowledge-models/list/detail/detail.png
diff --git a/docs/application/knowledge-models/list/index/list.png b/docs/application/knowledge-models/list/index/list.png
diff --git a/docs/application/profile/about/modal.png b/docs/application/profile/about/modal.png
diff --git a/docs/application/profile/assigned-comments.rst b/docs/application/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/application/profile/assigned-comments/list.png b/docs/application/profile/assigned-comments/list.png
diff --git a/docs/application/profile/edit/active-sessions/form.png b/docs/application/profile/edit/active-sessions/form.png
diff --git a/docs/application/profile/index.rst b/docs/application/profile/index.rst
@@ -3,7 +3,7 @@
 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| instance using :guilabel:`About`, or in case of problems we can use :guilabel:`Report issue` to know how to proceed.
 
@@ -25,6 +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>
 
diff --git a/docs/application/profile/index/menu.png b/docs/application/profile/index/menu.png
diff --git a/docs/application/projects/list/create/project-create-custom.png b/docs/application/projects/list/create/project-create-custom.png
diff --git a/docs/application/projects/list/detail/documents/list.png b/docs/application/projects/list/detail/documents/list.png
diff --git a/docs/application/projects/list/detail/documents/new.png b/docs/application/projects/list/detail/documents/new.png
diff --git a/docs/application/projects/list/detail/index/questionnaire.png b/docs/application/projects/list/detail/index/questionnaire.png
diff --git a/docs/application/projects/list/detail/metrics/metrics.png b/docs/application/projects/list/detail/metrics/metrics.png
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
diff --git a/docs/application/projects/list/detail/preview/download.png b/docs/application/projects/list/detail/preview/download.png
diff --git a/docs/application/projects/list/detail/preview/preview-html.png b/docs/application/projects/list/detail/preview/preview-html.png
diff --git a/docs/application/projects/list/detail/questionnaire.rst b/docs/application/projects/list/detail/questionnaire.rst
@@ -206,6 +206,12 @@ 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<profile>`.
 
 Comment Threads
 ---------------
@@ -214,13 +220,21 @@ 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
 ------------
 
 Besides comments there are also editor notes which work the same way as comments but they are visible only to project editors and owners. We can use editor notes to internal communication with our team while working on the DMP and then comments to gather the feedback from supervisor or reviewer.
 
-
 .. _todos:
 
 TODOs

diff --git a/docs/application/projects/list/detail/questionnaire/comments.png b/docs/application/projects/list/detail/questionnaire/comments.png
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
diff --git a/docs/application/projects/list/detail/questionnaire/version-history.png b/docs/application/projects/list/detail/questionnaire/version-history.png
diff --git a/docs/application/projects/list/detail/settings/settings.png b/docs/application/projects/list/detail/settings/settings.png
diff --git a/docs/application/projects/list/detail/sharing/share-dropdown.png b/docs/application/projects/list/detail/sharing/share-dropdown.png
diff --git a/docs/application/projects/list/detail/sharing/share-modal.png b/docs/application/projects/list/detail/sharing/share-modal.png
diff --git a/docs/application/projects/list/index/project-list.png b/docs/application/projects/list/index/project-list.png
diff --git a/docs/application/projects/list/migration/create.png b/docs/application/projects/list/migration/create.png
diff --git a/docs/application/projects/list/migration/migration.png b/docs/application/projects/list/migration/migration.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,7 +25,7 @@
 project_name_full = 'Data Stewardship Wizard'
 
 # The full version, including alpha/beta/rc tags
-version = release = '4.8'
+version = release = '4.9'
 
 rst_prolog = f"""
 

diff --git a/docs/more/development/api.rst b/docs/more/development/api.rst
@@ -36,4 +36,3 @@ After obtaining your authentication token and reviewing the API documentation, y
     response.raise_for_status()
     user = response.json()
     print(f'This API Key belongs to {user["email"]}')
-
diff --git a/docs/more/miscellaneous/dsw-registry/dsw-registry.png b/docs/more/miscellaneous/dsw-registry/dsw-registry.png
diff --git a/docs/more/self-hosted-dsw/upgrade-guidelines.rst b/docs/more/self-hosted-dsw/upgrade-guidelines.rst
@@ -42,7 +42,12 @@ Usually, nothing special is required for the upgrade. Internal structure changes
 .. Warning::
 
    Make sure to stop ``document-worker`` and ``mailer`` before upgrading to the next version. Run ``wizard-server`` first, then run the workers. Otherwise the database migrations might not work correctly.
-
+
+4.8.X to 4.9.X
+----------------
+
+*(nothing)*
+
 4.7.X to 4.8.X
 ----------------
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,4 +36,3 @@ After obtaining your authentication token and reviewing the API documentation, y
		response.raise_for_status()
		user = response.json()
		print(f'This API Key belongs to {user["email"]}')