Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 12 additions & 4 deletions docs/getting_started/dashboard/dashboard_block_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,19 @@ On the **Design** tab, in the **View** field, select the layout to be used to pr

## Recent activity block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]

Displays a list of recent activity of all or selected users.
It also includes a link to view all activities available in Admin tab.
Displays recent activity of all or selected users, and for selected object classes. Lists the following details:

- action time
- user reference (avatar, first and last name) with a link to the user profile (if available)
- activity type with context
Copy link
Contributor

Choose a reason for hiding this comment

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

I prefer having only the settings as a list, it help to skim the reference to have this visual pattern.


It also includes a link to view all activities in the Admin tab of the Back Office.

!!! note

For the [recent activity](recent_activity.md) log to be displayed, your [user role](permission_system.md) must have the **Activity Log / Read** permission.


Recent activity block contains the following data: action time, User reference (avatar, first and last name) with a link to the user profile (if available),
Activity type with the context.

On the **Properties** tab, set values in the following fields:

Expand Down
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
41 changes: 27 additions & 14 deletions docs/getting_started/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,34 +35,47 @@ 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
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm tempted to go further, and have two "View user profile" and "Edit user profile" sections

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think it's necessary to go so granular.

Copy link
Contributor

Choose a reason for hiding this comment

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

Why not even simpler?

Suggested change
### View and edit user profile
### User profile

Copy link
Contributor Author

@dabrt dabrt Mar 15, 2024

Choose a reason for hiding this comment

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

I prefer having a verb here, to show that we're task oriented

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm agree. And for consistency of the ToC

  • Access the Back Office
    • View and edit user profile
    • Change the password and other user settings


You can edit your profile and modify the following data:
If you are an editor, depending of 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
Comment on lines -42 to -43
Copy link
Contributor

Choose a reason for hiding this comment

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

Are they removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Obvious mistake, thank you

- Signature
- Email
- Department
- Position
- Location
- Signature
- Roles the user is assigned to
- Recent activity

!!! note
Copy link
Contributor

Choose a reason for hiding this comment

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

Why you removed note about fields visibility? It's important.

Copy link
Contributor Author

@dabrt dabrt Mar 15, 2024

Choose a reason for hiding this comment

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

It is there, in the first sentence: “depending of the system configuration, you may be able to view...”, and the note broke the flow of text. Too many distractors.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd keep as note, for better visibility.

Copy link
Contributor

Choose a reason for hiding this comment

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

But this note is now about "view". I'll add it back but under the "edit" pargraph.

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")

To access the user profile, in the upper-right corner of the screen, click the avatar icon.
Then, from the drop-down menu, select **Profile**.

2\.From the drop-down menu, select **Profile**.
Copy link
Contributor

Choose a reason for hiding this comment

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

If you'll decide to keep list, add space between dot and number.

To edit the user profile, in the User profile screen, the **Summary** section, click **Edit**.

3\. In the User profile screen, in the **Summary** section, click **Edit**.
You can now modify the following entries:

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.
- Avatar image
- First and last name
- Signature
- Department

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.
After you finish, the avatar is uploaded and is visible in the Back Office.
Comment on lines 60 to +70
Copy link
Contributor

Choose a reason for hiding this comment

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

Was it necessary to rewrite these steps? Original ones are clear and short.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The “Get started” topic is more about getting to know the system, none of the sections above and below uses numbered lists. So for the sake of consisutency, I changed steps into a verbose paragraph.

Copy link
Contributor

Choose a reason for hiding this comment

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

We are using numbered list in the docs, so even if just one section on the whole page needs it, why don't use it? If it's clear and short, doesn't make sense to rewrite it. I'd totally keep list, it's 'Getting started' and we should start easy ;)

Copy link
Contributor

Choose a reason for hiding this comment

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

I like Tomasz proposal's flow

To access your user profile,…
To edit your user profile,…
To edit your avatar,…

Each topic as very few steps in a relatively short sentence so, IMHO, it stays clear enough.


![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.
1 change: 1 addition & 0 deletions docs/permission_management/permissions_and_users.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ With the permission system of [[= product_name =]] you can control which users h
"permission_management/permission_system",
"permission_management/work_with_permissions",
"user_management/manage_users",
"recent_activity/recent_activity"
], columns=4) =]]
70 changes: 27 additions & 43 deletions docs/recent_activity/recent_activity.md
Copy link
Contributor

Choose a reason for hiding this comment

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

It lacks explanation for Activity Log timestamps. What are the time frames.
Also please replace a screenshot, Recent activity is written with a sentence case and it's already fixed on the UI.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Original file line number Diff line number Diff line change
@@ -1,70 +1,54 @@
---
description: Monitor recent activity logged actions.
description: Monitor recently logged user actions.
edition: experience
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

---

# Recent activity log [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]
# Review recent user activity
Copy link
Contributor

Choose a reason for hiding this comment

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

It's just an introduction, "action" is not needed here, in my opinion.

Suggested change
# Review recent user activity
# Recent user activity

Copy link
Contributor

Choose a reason for hiding this comment

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

I wouldn't change my section title. "user" could make reader forget that this is about repository activity and if there is a user, it could be a user logged by a scheduled script or other automation.


## Activity list
[[= product_name =]] logs various operations on the repository and in the application.
If you have administrator permissions and your [user role](permission_system.md) has the **Activity Log / Read** permission, you can review the most recent activity log in the Back Office, the Admin tab.

In the Back Office, **Admin** -> **Activity list**, you can see a list of recent activity of all or selected users.
Depending on the system configuration, activity logs may also be shown:

- on the Dashboard, the [Recent activity block](dashboard_block_reference.md#recent-activity-block)
- within the [user profile](../getting_started/get_started.md#view-and-edit-user-profile)

!!! note

To see the **Admin** menu, you need the **Setup / Administrate** [permission](permission_system.md).
To see the Activity list, you need the **Activity Log / Read** permission (this permission can be limited to allow seeing your own activity only).
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).

## View user activity in Back Office

By default, the following actions are displayed:
In the Back Office, go to **Admin** -> **Activity list**, to see recent activity of all or selected users.

The following actions are displayed:

- [Content](content_items.md) create, create draft, publish, update, trash, recover, delete, delete translation, hide, and reveal
- [Location](manage_locations_urls.md#content-locations) create, delete, hide, reveal, update, move, swap, and subtree copy
- [Product](products.md) create, update, and delete
- [Product variant](work_with_product_variants.md) create, update, and delete
- [Site](work_with_sites.md) create, update, and delete
Comment on lines 28 to 32
Copy link
Contributor

Choose a reason for hiding this comment

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

It should be put into the table for better reading experience.

Copy link
Contributor

@adriendupuis adriendupuis Mar 19, 2024

Choose a reason for hiding this comment

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

@juskora Or not listed at all.

All actions on the following items are logged:

- [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)

"All actions on …" or even "Actions on …"

Copy link
Contributor

Choose a reason for hiding this comment

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

I was trying to be exhaustive by reminding all possible actions on each item.
From my POV, a table would convey a wrong message about what is supported and what's not. But maybe I think that because I don't see the same table.

Type publish
Content ✔️
Location

This kind of table say that Location/publish is not logged. It doesn't say that there is nothing to log as Location/publish doesn't exist.


By default, log entries are kept 30 days.

Log entries are grouped by logical bonds like web requests, events, batches, or sessions.

![Activity list](img/4.6_activity_list.png)
![Activity list](img/4.6_activity_list.png "Activity list")

!!! note

With some development, some other actions could be logged, see [custom log entry developer documentation]([[= developer_doc =]]/administration/recent_activity/recent_activity/#adding-custom-activity-log-entries)

The log entries' life time can be shorten or extended through configuration, see [configuration developer documentation]([[= developer_doc =]]/administration/recent_activity/recent_activity/#configuration-and-cronjob)

### 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](img/filters.png)

## Recent activity dashboard block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]

You can add a [**Recent activity** block](dashboard_block_reference.md#recent-activity-block) to your [dashboard](dashboard.md).
To be able to customize a dashboard, you need the **Dashboard / Customize** permission.
To be able to see the content of this block, you need the **Activity Log / Read** permission.

!["Recent activity" block](img/recent_activity_block.png)
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).

You can set the block to display only activities of selected users, or concerning particular object classes.
### Filter activity

For example, the following dashboard block focuses on Content and Location activity.
You can filter the actions to:

!["Content recent activity" block settings](img/recent_activity_block_settings.png)
* follow the activity of a selected user or user group
* narrow down the results to selected item types or actions

## User profile
To do it, in the **Filters** area, select filters of your choice, and click **Apply**.
Click **Clear** to reset all the filters.

User profile displays recent activity of the user.
To be able to see recent activity log, you need the **Activity Log / Read** permission.
For example, you can narrow down the results by selecting the **Action** and **Time** filters, so that the activity list displays actions only of the `Publish` type from `Last week`.

![Recent activity in the user profile](img/recent_activity_user_profile.png)
![Published last week filter set](img/filters.png "Published last week filter set")
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +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
- Review recent activity: recent_activity/recent_activity.md
Copy link
Contributor

Choose a reason for hiding this comment

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

Recent activity is a part of dashboad per Radek request to be added in the user profile section, not hidden in Users and permissions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are three places in user doc where we mention the activity log,
The profile, aimed at mr Smith the editor, few options, basically for seeing ones own actions..
The dashboard - more complex, but in block reference we tend not to describe functionality in full, due to consistency, space consstraints, etc.
Admin UI - most developed, aimed at the admin persona, with filtering by users, types of events, etc. This is where a robust description should go IMVHO
@radzyu ?

Copy link
Contributor

@adriendupuis adriendupuis Mar 19, 2024

Choose a reason for hiding this comment

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

@juskora
Originally if I didn't describe so much the dashboard's or the profile's recent activity, it's because there juste embedments of the main feature, the admin page. The 3 elements are protected by the same permission.

- User paths:
- Explorer: persona_paths/explorer.md
- Administrator:
Expand Down