IBX-6717: Recent activity: Alternative info organization #278

dabrt · 2024-03-15T00:57:33Z

Different approach to information organization

Counter-proposal to #274 and #237

Checklist

Text renders correctly
Text has been checked with vale
Description metadata is up to date
Redirects cover removed/moved pages

sonarqubecloud · 2024-03-15T00:57:55Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

adriendupuis · 2024-03-15T08:45:14Z

docs/getting_started/get_started.md

 ![Login screen](img/login_form.png "Login screen")

-### Edit user profile
+### View and edit user profile


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

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

Why not even simpler?

Suggested change

### View and edit user profile

### User profile

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

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

juskora

Recent activity must be moved to Getting started around the Dashboard section.

juskora · 2024-03-15T09:48:38Z

docs/getting_started/get_started.md

+- Roles the user is assigned to
+- Recent activity

 !!! note


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

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.

I'd keep as note, for better visibility.

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

juskora · 2024-03-15T09:51:24Z

docs/getting_started/get_started.md


-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.


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

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.

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

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.

juskora · 2024-03-15T10:02:28Z

mkdocs.yml

        - 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


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

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 ?

@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.

juskora · 2024-03-15T10:18:19Z

docs/getting_started/get_started.md

 ![Login screen](img/login_form.png "Login screen")

-### Edit user profile
+### View and edit user profile


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

juskora · 2024-03-15T10:40:53Z

docs/recent_activity/recent_activity.md

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


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

@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 …"

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.

juskora · 2024-03-15T10:52:21Z

docs/recent_activity/recent_activity.md

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.

@adriendupuis

julitafalcondusza · 2024-03-15T10:50:18Z

docs/getting_started/get_started.md

 ![Login screen](img/login_form.png "Login screen")

-### Edit user profile
+### View and edit user profile


Why not even simpler?

Suggested change

### View and edit user profile

### User profile

julitafalcondusza · 2024-03-15T10:53:44Z

docs/getting_started/get_started.md

+- Roles the user is assigned to
+- Recent activity

 !!! note


I'd keep as note, for better visibility.

julitafalcondusza · 2024-03-15T10:54:03Z

docs/getting_started/get_started.md

- Avatar image
- First and last name


Are they removed?

Obvious mistake, thank you

julitafalcondusza · 2024-03-15T10:59:23Z

docs/getting_started/get_started.md


-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.


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

julitafalcondusza · 2024-03-15T11:08:32Z

docs/recent_activity/recent_activity.md

 ---

-# Recent activity log [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]]
+# Review recent user activity


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

Suggested change

# Review recent user activity

# Recent user activity

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.

julitafalcondusza · 2024-03-15T11:10:02Z

docs/getting_started/get_started.md

+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**.


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

adriendupuis · 2024-03-19T10:12:49Z

docs/recent_activity/recent_activity.md

 ---
-description: Monitor recent activity logged actions.
+description: Monitor recently logged user actions.
+edition: experience


adriendupuis · 2024-03-20T13:50:58Z

docs/getting_started/dashboard/dashboard_block_reference.md

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


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

adriendupuis · 2024-03-21T08:07:55Z

Most of this was transferred to #237 through #274 and c95cbd3

Thank you @dabrt

adriendupuis and others added 2 commits February 26, 2024 12:35

get_started.md: Talk about recent activity in user profile

c2878e7

Different take on info presentation

8d3f06e

dabrt requested a review from adriendupuis March 15, 2024 00:58

dabrt added the Needs DOC review label Mar 15, 2024

adriendupuis reviewed Mar 15, 2024

View reviewed changes

juskora requested changes Mar 15, 2024

View reviewed changes

julitafalcondusza requested changes Mar 15, 2024

View reviewed changes

adriendupuis changed the title ~~Alternative info organization~~ IBX-6717: Recent activity: Alternative info organization Mar 15, 2024

adriendupuis reviewed Mar 19, 2024

View reviewed changes

adriendupuis reviewed Mar 20, 2024

View reviewed changes

adriendupuis mentioned this pull request Mar 21, 2024

IBX-6717: About recent activity in user profile #274

Merged

5 tasks

adriendupuis closed this Mar 21, 2024

adriendupuis deleted the alternative_info_organization branch March 21, 2024 08:08

IBX-6717: Recent activity: Alternative info organization #278

IBX-6717: Recent activity: Alternative info organization #278

Uh oh!

Conversation

dabrt commented Mar 15, 2024 • edited by adriendupuis Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

sonarqubecloud bot commented Mar 15, 2024

Quality Gate passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dabrt Mar 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

juskora left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dabrt Mar 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adriendupuis Mar 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adriendupuis Mar 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dabrt commented Mar 15, 2024 •

edited by adriendupuis

Loading

dabrt Mar 15, 2024 •

edited

Loading

dabrt Mar 15, 2024 •

edited

Loading

adriendupuis Mar 19, 2024 •

edited

Loading

adriendupuis Mar 19, 2024 •

edited

Loading