Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IBX-6717: Recent activity #237

Merged
merged 38 commits into from
Apr 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
53a3ad4
Start Recent Activity doc
adriendupuis Oct 23, 2023
25300ec
Start Recent Activity doc
adriendupuis Oct 23, 2023
26ac198
recent_activity.md: Fix Ibexa.EOLWhitespace
adriendupuis Oct 25, 2023
7dc64f2
recent_activity.md: Update logged actions
adriendupuis Dec 4, 2023
d834652
recent_activity.md: Fix link to work_with_sites.md
adriendupuis Dec 4, 2023
26a6508
Merge branch 'master' into recent_activity
adriendupuis Dec 4, 2023
f249c90
recent_activity.md: Prepare "Dashboard block" section
adriendupuis Dec 12, 2023
d6c6c79
recent_activity.md: Filters screenshot
adriendupuis Jan 30, 2024
6106dbe
recent_activity.md: Activity list screenshot
adriendupuis Feb 6, 2024
350aae4
recent_activity.md: Recent activity block settings
adriendupuis Feb 13, 2024
59a61b1
recent_activity.md: Recent activity in user profile
adriendupuis Feb 13, 2024
a3ba5fe
recent_activity.md: Recent activity in user profile
adriendupuis Feb 13, 2024
93c9a78
recent_activity.md: Recent activity in user profile
adriendupuis Feb 13, 2024
23ee2ee
recent_activity.md: Recent activity in user profile
adriendupuis Feb 13, 2024
5454eb6
recent_activity.md: vale
adriendupuis Feb 13, 2024
bf6aad7
Apply suggestions from code review
adriendupuis Feb 13, 2024
a48a780
Merge branch 'master' into recent_activity
adriendupuis Feb 15, 2024
325bb26
recent_activity.md: About permission
adriendupuis Feb 15, 2024
66a6ba5
recent_activity.md: Format menu path
adriendupuis Feb 15, 2024
0991e73
docs/recent_activity/img/: add borders
adriendupuis Feb 16, 2024
b59756e
Apply suggestions from code review
adriendupuis Feb 19, 2024
b33470a
mkdocs.yml: Move Recent activity into Permissions and users
adriendupuis Feb 20, 2024
1d184ca
recent_activity.md: streamlines links in logged action list
adriendupuis Feb 23, 2024
8bccb3d
recent_activity.md: logged action list: add "create draft"
adriendupuis Feb 23, 2024
d295a4d
recent_activity.md: links to dev doc
adriendupuis Feb 23, 2024
dc582cd
recent_activity.md: logged action list: add missing commas
adriendupuis Feb 23, 2024
1786637
Apply suggestions from code review
adriendupuis Feb 23, 2024
910a61f
recent_activity.md: Enhance menu items' format
adriendupuis Feb 23, 2024
1e0d3ed
recent_activity.md: permission for dashboard block
adriendupuis Feb 26, 2024
4623c74
Apply suggestions from code review
adriendupuis Feb 26, 2024
50515ac
Merge branch 'master' into recent_activity
adriendupuis Feb 26, 2024
df71f70
recent_activity.md: Update link to dashboard and dashboard block
adriendupuis Feb 26, 2024
53686c6
recent_activity.md: Move badges to meta-data
adriendupuis Mar 20, 2024
231d771
recent_activity.md: Rework, Rm user profile and dashboard block sections
adriendupuis Mar 20, 2024
7658eea
recent_activity.md: Rm unused img, rework img usage
adriendupuis Mar 20, 2024
c150a9c
IBX-6717: About recent activity in user profile (#274)
adriendupuis Mar 20, 2024
2649686
update recent activity screenshot, left menu was outdated
adriendupuis Apr 9, 2024
dba3bab
recent_activity.md: Remove old duplicate note box
adriendupuis Apr 9, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting_started/discover_ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down
43 changes: 31 additions & 12 deletions docs/getting_started/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,34 +35,53 @@

![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:

Check warning on line 40 in docs/getting_started/get_started.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/getting_started/get_started.md#L40

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/getting_started/get_started.md", "range": {"start": {"line": 40, "column": 1}}}, "severity": "WARNING"}

- 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

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/recent_activity/img/recent_activity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 60 additions & 0 deletions docs/recent_activity/recent_activity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---

Check warning on line 1 in docs/recent_activity/recent_activity.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/recent_activity/recent_activity.md#L1

[Ibexa.ReadingLevel] The grade level is 7.30. Aim for 8th grade or lower by using shorter sentences and words.
Raw output
{"message": "[Ibexa.ReadingLevel] The grade level is 7.30. Aim for 8th grade or lower by using shorter sentences and words.", "location": {"path": "docs/recent_activity/recent_activity.md", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
description: Monitor recent activity logged actions.
edition: experience
---

# Recent activity log
adriendupuis marked this conversation as resolved.
Show resolved Hide resolved

[[= 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).
Comment on lines +23 to +30
Copy link
Contributor Author

@adriendupuis adriendupuis Apr 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️
Wait for the merge
There are links to ibexa/documentation-developer#2161


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)

Check warning on line 44 in docs/recent_activity/recent_activity.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/recent_activity/recent_activity.md#L44

[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.", "location": {"path": "docs/recent_activity/recent_activity.md", "range": {"start": {"line": 44, "column": 10}}}, "severity": "WARNING"}
- within the [user profile](get_started.md#view-and-edit-user-profile)

Check warning on line 45 in docs/recent_activity/recent_activity.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/recent_activity/recent_activity.md#L45

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/recent_activity/recent_activity.md", "range": {"start": {"line": 45, "column": 71}}}, "severity": "WARNING"}

## 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")
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading