Documentation: New activity panel, emoji reactions and auto polling (#…

…17118) * First draft of docs on the new Activity panel This includes docs on: - Timeline view - Fixed comment box - Emoji reactions - Automatic updates * Added screenshots * Fixed image links * Updated metadata * Minor changes after review * Apply suggestions from code review * Update docs/user-guide/activity/README.md --------- Co-authored-by: Parimal Satyal <[email protected]> Co-authored-by: Maya Berdygylyjova <[email protected]>
opf · Nov 12, 2024 · 5d88da9 · 5d88da9
1 parent b662b64
commit 5d88da9
Show file tree

Hide file tree

Showing 10 changed files with 79 additions and 15 deletions.
diff --git a/docs/user-guide/activity/Activity-addEmoji.png b/docs/user-guide/activity/Activity-addEmoji.png
diff --git a/docs/user-guide/activity/Activity-changeset.png b/docs/user-guide/activity/Activity-changeset.png
diff --git a/docs/user-guide/activity/Activity-comment.png b/docs/user-guide/activity/Activity-comment.png
diff --git a/docs/user-guide/activity/Activity-commentBox.png b/docs/user-guide/activity/Activity-commentBox.png
diff --git a/docs/user-guide/activity/Activity-filter.png b/docs/user-guide/activity/Activity-filter.png
diff --git a/docs/user-guide/activity/Activity-mention.png b/docs/user-guide/activity/Activity-mention.png
diff --git a/docs/user-guide/activity/Activity-more.png b/docs/user-guide/activity/Activity-more.png
diff --git a/docs/user-guide/activity/Activity-sortOrder.png b/docs/user-guide/activity/Activity-sortOrder.png
diff --git a/docs/user-guide/activity/Activity-tab.png b/docs/user-guide/activity/Activity-tab.png
diff --git a/docs/user-guide/activity/README.md b/docs/user-guide/activity/README.md
@@ -2,11 +2,86 @@
 sidebar_navigation:
   title: Activity
   priority: 890
-description: Find out about the Activity within a project
-keywords: activity
+description: Get an overview of changes and comments within a single work package or the latest activity within a project. The activity tab in work packages also lets you mention and notify other users.
+keywords: activity, comment, mention, emoji, reaction
 ---
 
-# Activity
+# Project and work package activity
+
+OpenProject makes it easy to keep track of what's going on in [specific work packages](#work-package-activity) and in your [projects](#project-activity).
+
+## Work package activity
+
+The Activity tab within a work package maintains a history of all updates and changes, along with all conversations concerning that work package. This tab is accessible both in full work packages view and in split screen mode.
+
+![The work package Activity tab split screen](Activity-tab.png)
+
+When you first access this tab, you will see the comments and list of changes in a timeline. This timeline can be sorted in either chronological (the newest comments at the bottom) or antichronological order (the newest comments on top):
+
+![You can order the activities to show newest on top or at the bottom](Activity-sortOrder.png)
+
+You can scroll up and down to go forwards or backwards in time.
+
+By default, the activity tab shows both comments and changes, but you can filter this to only show one or the other:
+
+![Filter the activity tab](Activity-filter.png)
+
+### Change sets
+
+When you or another user makes changes to the work package, the updates are listed below the name of the author of those changes. All changes made within the aggregation period (defined by the administrator) are grouped together under one change set.
+
+![Changes made at the same time are grouped together](Activity-changeset.png)
+
+If a comment was also added, then the changes are listed below the associated comment.
+
+### Comments
+
+Comments allow you to have a conversation about the present work package with other project members, or comment changes you have made.
+
+![A single comment](Activity-comment.png)
+
+To add a new comment to a work package, click on the comment box at the bottom of the Activity tab. This will expand it and give you formatting options. Click on the post icon or press Command + Enter on your keyboard to publish your comment.
+
+![The comment box expands when you write your comment](Activity-commentBox.png)
+
+The more icon (⋯) next to a comment gives you a number of additional functions.
+
+![More menu on a comment](Activity-more.png)
+
+You can:
+
+- Copy a link to the comment on your clipboard if you want to paste a link to it elsewhere  
+- You can edit the comment if you are the author  
+- You can quote someone else's comment in a new comment. This is useful if you want to respond to a certain part of a comment.
+
+### Emoji reactions
+
+Starting with version 15.0, you can respond to comments with emoji reactions to quickly communicate basic messages without having to add a comment.
+
+To do so, click on the emoji icon next to each comment and pick from one of eight possible emojis.
+
+![Click the emoji icon to see a list of available emojis](Activity-addEmoji.png)
+
+You can add multiple emojis, or simply click on an emoji that was already used by someone else to add to it.
+> [!TIP]
+> Please note that emoji reactions will not trigger notifications. If you need your colleague to be notified about your reaction, leave a regular comment.
+
+### Mentions
+
+If you would like to direct your comment to particular project members or get their attention, you can @mention them. To do this, type `@` and select the user whom you want to mention.
+
+![Write @ and a user name to mention other users](Activity-mention.png)
+
+The user will then receive a notification, which allows them to easily see the comment in which they have been mentioned.
+
+### Automatic updates 
+
+Starting with OpenProject 15.0, changes other users make to the currently open work package are visible nearly immediately, in real-time. For example, if someone changes the assignee, edits the description and leaves a comment, all of these things will automatically be reflected in the open work package without any action on your part.
+
+> [!TIP]
+> If you are currently editing a work package and someone else edits it at the same time, you will receive a warning letting you know that you will not be able to save your changes till your refresh the page. This gives you the opportunity to copy your work elsewhere so that it isn't lost, and that your edit do not overwrite those of someone else.
+
+## Project activity
 
 OpenProject lets you view an overview of all recent changes within a project. These include changes to:
 
@@ -18,7 +93,7 @@ OpenProject lets you view an overview of all recent changes within a project. Th
 
 To view project activity, the **Activity** module must first be enabled.
 
-## Activate Activity in a project
+### Activate project activity
 
 Within a project, navigate to the **Project settings > Modules** page. Make sure the **Activity** module is enabled and click on the **Save** button at the bottom of the page.
 
@@ -69,14 +144,3 @@ You can [configure in the admin settings](../../system-admin-guide/) how many da
 
 > **Note:** The project activity list is paginated. You can click on the "Previous" or "Next" links at the bottom of the page (where applicable) to navigate between pages.
 
-### Work package Activity
-
-When you open a work package, e.g. by clicking on the ID of the work package in the work package table, you have the Activity area next to the Work package information area on the right side.
-
-![work package activity](work-package-activity.png)
-
-There, all changes and activities concerning the work package are documented, e.g. if a user changes the status of the work package, this activity is recorded with the information who, when and what in the Activity area and is visible for other users who have the corresponding authorization.
-
-You can also use the Activity area as a chat portal and share messages with other team members there.![Work package activity flag someone](Work-package-activity-flag-someone.png)
-
-If you want to notify a specific user about something in the Activity section, you can also flag them with an "@" symbol in front of their username so that they receive a notification within OpenProject.