IBX-6717: Recent activity (#237)

--------- Co-authored-by: Adrien Dupuis <[email protected]> Co-authored-by: Paweł Niedzielski <[email protected]> Co-authored-by: Tomasz Dąbrowski <[email protected]> Co-authored-by: julitafalcondusza <[email protected]>
ibexa · Apr 19, 2024 · 1a5d4fc · 1a5d4fc
1 parent 5522279
commit 1a5d4fc
Show file tree

Hide file tree

Showing 7 changed files with 93 additions and 13 deletions.
diff --git a/docs/getting_started/discover_ui.md b/docs/getting_started/discover_ui.md
@@ -14,7 +14,7 @@ Depending on your location within the Back Office, it can contain the following
 - Global search field that allows you to [find content](../search/search_for_content.md) by checking all searchable Fields
 - Drop-down that changes the site context
 - Notification icon that informs you about incoming assignments, for example, items assigned for [your review](../content_management/workflow_management/editorial_workflow.md#review-queue)
-- User avatar with a drop-down menu with access to [user profile and settings](get_started.md#edit-user-profile)
+- User avatar with a drop-down menu with access to [user profile and settings](get_started.md#view-and-edit-user-profile)
 
 !!! note "Site context"
 

diff --git a/docs/getting_started/get_started.md b/docs/getting_started/get_started.md
@@ -35,34 +35,53 @@ Otherwise, to login, you must get your user credentials from the administrator a
 
 ![Login screen](img/login_form.png "Login screen")
 
-### Edit user profile
+### View and edit user profile
 
-You can edit your profile and modify the following data:
+If you are an editor, depending on the system configuration, you may be able to view and edit the user profile, which can contain the following information:
 
 - Avatar image
 - First and last name
-- Signature
+- Email
 - Department
+- Position
+- Location
+- Signature
+- Roles the user is assigned to
+- Recent activity
 
 !!! note
-    The fields may differ depending on your system configuration.
 
-1\. To modify profile, in the upper-right corner, click the avatar icon. 
+    For the [recent activity](recent_activity.md) log to be displayed, your [user role](../permission_management/permissions_and_users.md) must have the **Activity Log / Read** permission.
+
+![User profile](img/user_profile_preview.png "User profile")
 
-2\.From the drop-down menu, select **Profile**.
+To access your user profile, in the upper-right corner of the screen, click your avatar icon.
+Then, from the drop-down menu, select **Profile**.
 
-3\. In the User profile screen, in the **Summary** section, click **Edit**.
+To edit your user profile, in the **User profile** screen, in the **Summary** section, click **Edit**.
 
-4\. Go to **Image** and click **Upload file** or drag and drop your photo.
-If necessary, you can edit the foto with the Image Editor.
+You can now modify the following entries:
+
+- Avatar image
+- First and last name
+- Signature
+- Department
+
+!!! note
+
+    The fields may differ depending on your system configuration.
+
+To edit your avatar, in the **Image** area, click **Upload file** or drag and drop your photo.
+If necessary, you can [edit the photo with the Image Editor](edit_images.md).
+After you finish, the avatar is uploaded and is visible in the Back Office.
 
 ![Edit avatar](img/user_profile_avatar.png "Edit avatar")
 
-5\. Now your avatar photo has been uploaded and is visible in the Back Office.
+!!! note
 
-6\. To save changes, click **Update**.
+    If you don't set your own image, a default avatar with your initials is displayed.
 
-If you don't set your own image, a default avatar with your initials is displayed.
+To save changes to the user profile, click **Update**.
 
 ### Change the password and other user settings
 

diff --git a/docs/getting_started/img/user_profile_preview.png b/docs/getting_started/img/user_profile_preview.png
diff --git a/docs/recent_activity/img/recent_activity.png b/docs/recent_activity/img/recent_activity.png
diff --git a/docs/recent_activity/img/recent_activity_filters.png b/docs/recent_activity/img/recent_activity_filters.png
diff --git a/docs/recent_activity/recent_activity.md b/docs/recent_activity/recent_activity.md
@@ -0,0 +1,60 @@
+---
+description: Monitor recent activity logged actions.
+edition: experience
+---
+
+# Recent activity log
+
+[[= product_name =]] logs various operations on the repository and in the application.
+
+If you have **Setup / Administrate** and **Activity Log / Read** [permissions](permission_system.md),
+you can review the most recent activity log in  the Back Office, **Admin** -> **Recent activity**.
+
+![Recent activity](recent_activity.png "Recent activity")
+
+By default, actions on the following items are displayed:
+
+- [Content](content_items.md)
+- [Location](manage_locations_urls.md#content-locations)
+- [Product](products.md)
+- [Product variant](work_with_product_variants.md)
+- [Site](work_with_sites.md)
+
+!!! note
+
+    If your implementation requires that other actions are logged,
+    see [custom log entry developer documentation]([[= developer_doc =]]/administration/recent_activity/recent_activity/#adding-custom-activity-log-entries).
+
+    By default, log entries are kept for 30 days.
+    This time can be modified through configuration.
+    For more information, see [developer documentation]([[= developer_doc =]]/administration/recent_activity/recent_activity/#configuration-and-cronjob).
+
+Log entries are grouped by date,
+then by logical bond (like web request, or migration file).
+
+Each activity log entry shows
+
+- when the action was performed,
+- who performed it (avatar, first name, last name),
+- the action itself as a verb,
+- and the item the action was performed on.
+
+Depending on the system configuration, activity logs may also be shown:
+
+- on the Dashboard with the [Recent activity block](dashboard_block_reference.md#recent-activity-block)
+- within the [user profile](get_started.md#view-and-edit-user-profile) 
+
+## Filter activities
+
+You can filter the activities to:
+
+* follow the activity of selected users or user group,
+* narrow the results to selected item types, or actions.
+
+To do it, on the right side, in the **Filters** menu, choose selected filters, and click the **Apply** button.
+Click the **Clear** button to reset all the filters.
+
+The following example shows, how to narrow the results by selecting **Action** and **Time** filters.
+With these settings, activity list displays only `Publish` actions from `Last week` time period.
+
+![Published last week](recent_activity_filters.png "Published last week filter set")
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -114,6 +114,7 @@ nav:
         - Permission system: permission_management/permission_system.md
         - Work with permissions: permission_management/work_with_permissions.md
         - Manage users: user_management/manage_users.md
+        - Recent activity: recent_activity/recent_activity.md
     - User paths:
         - Explorer: persona_paths/explorer.md
         - Administrator: