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

Activity feed #767

Open
3 of 6 tasks
MarieS-WiMLDS opened this issue Nov 18, 2024 · 6 comments
Open
3 of 6 tasks

Activity feed #767

MarieS-WiMLDS opened this issue Nov 18, 2024 · 6 comments
Assignees
Labels
enhancement New feature or request epic This issue represents major product increments

Comments

@MarieS-WiMLDS
Copy link
Contributor

MarieS-WiMLDS commented Nov 18, 2024

Is your feature request related to a problem? Please describe.

As a user, I want to see quickly items that are created, including warnings.

Describe the solution you'd like

This solution is very MVP. My goal is to create a spec that requires as little tech work, rework and object creation as possible at first.

In a view called "Activity feed", I want to see all the items created & the warnings.
The most recent should be on top.
Whenever an item is updated, the older version is deleted from the feed so it appears on top only.
If possible, the warnings shouldn't be items that appear in the items list on the left.

UI mockups

Application must now have two (virtual) pages. One for the project view, one for the activity feed.
There URL must be:

  • /#/project
  • /#/activity

A new vertical left bar (looking like a workspace switcher) will act as the main app navigation.

Flow _ Activity feed_light
light mode
Flow _ Activity feed_dark
dark mode

Figma source.

Describe alternatives you've considered, if relevant

No response

Additional context

Here is a list of questions that are either on hold, or answered in this specs in order to go towards an MVP that we can demo and experience, but not necessarily with the best answer:

  1. Should this activity feed be in a view or in another object?
  2. Should we enable the user to quickly send items to a given view from the feed?
  3. What happens to items which are updated? They are already in the feed, and we allow only once an item to appear. For now, older versions disappear and the most recent appears at the top.

Ready State Checklist

@MarieS-WiMLDS MarieS-WiMLDS added enhancement New feature or request needs-triage This has been recently submitted and needs attention and removed needs-triage This has been recently submitted and needs attention labels Nov 18, 2024
@tuscland
Copy link
Member

Should this activity feed be in a view or in another object?

To me, this is a dedicated space, ping @anasstarfaoui.

Should we enable the user to quickly send items to a given view from the feed?

This is a feature for a future iteration.

What happens to items which are updated? They are already in the feed, and we allow only once an item to appear. For now, older versions disappear and the most recent appears at the top.

You offer a first approach, and we can iterate on that.

@tuscland tuscland added the epic This issue represents major product increments label Nov 25, 2024
@tuscland
Copy link
Member

@MarieS-WiMLDS, I believe warnings should be kept in the context of their generation (typically the Python call). That is, warnings should not be elements of the Activity feed, but rather related to the resulting items.

I believe this serves two opportunities:

  1. Have a consistent presentation of warnings in their context, in the Activity Feed or in a view, how a user would find the warning would be the same.
  2. Opens the possibility of a dedicated space for warnings, basically another way of seeing entities of skore (think about datasets in the future).

Finally, it would make the Activity Feed simpler to implement.

What do you think?

cc @rouk1 @anasstarfaoui

@rouk1
Copy link
Contributor

rouk1 commented Nov 26, 2024

Ok for me, only caveat is that train_test_split does not have concrete item associated to id. Hence it will never goes to the UI.

@tuscland
Copy link
Member

Right, I forgot that warnings could be issued outside of the scope of an item. So there are two possibilities:

  • Enforce that warnings are related to an item (for example a train_test_split report)
  • Leave warnings free, but record their association when relevant. This makes up for a more complex domain model, but is more flexible.

@MarieS-WiMLDS
Copy link
Contributor Author

What I liked about having the warning in activity feed is that it can be presented nicely, with a nice police, in a paragraph instead of a line, etc.
However, it's true that I don't think flying warnings, without their context, are interesting for the user. Plus, when outside an item, we cannot log when they are solved.
Let's remove them from the first iteration.

@anasstarfaoui
Copy link

@rouk1 rouk1 linked a pull request Nov 28, 2024 that will close this issue
@MarieS-WiMLDS MarieS-WiMLDS self-assigned this Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request epic This issue represents major product increments
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants