[Proposal] Improve the Notifications Module to replace the Watchlist

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[Proposal] Improve the Notifications Module to replace the Watchlist

Guillaume Delhumeau
Hello developers!

The new roadmap has been voted and I continue my work on the notifications
module. You might have played with it since the 9.2 release and I hope you
like it.

Now I need to implement the email part of the notifications module. It
means that users could decide either the notifications are displayed on the
top menu or sent by emails periodically. Having this in mind, it is clear
that it conflicts with the Watchlist.

The plan is to move to contrib the Watchlist application (when possible)
and to implement the same features inside the notifications module.

Any objection before I start the work?

Thanks,

--
Guillaume Delhumeau ([hidden email])
Research & Development Engineer at XWiki SAS
Committer on the XWiki.org project
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [Proposal] Improve the Notifications Module to replace the Watchlist

vmassol
Administrator
Hi Guillaume,

> On 10 Apr 2017, at 17:34, Guillaume Delhumeau <[hidden email]> wrote:
>
> Hello developers!
>
> The new roadmap has been voted and I continue my work on the notifications
> module. You might have played with it since the 9.2 release and I hope you
> like it.
>
> Now I need to implement the email part of the notifications module. It
> means that users could decide either the notifications are displayed on the
> top menu or sent by emails periodically.

I don’t think it’s “either”. IMO they could have both at the same time.

Also it shouldn’t have to be only periodically; it’s important to include the realtime notification too.

> Having this in mind, it is clear
> that it conflicts with the Watchlist.
>
> The plan is to move to contrib the Watchlist application (when possible)
> and to implement the same features inside the notifications module.
>
> Any objection before I start the work?

Sounds good to me. The Notifications module should encompass all features from AS and Watchlist IMO.

Various ideas:
* From an architecture POV I think we should have some generic way to be able to subscribe to notifications by XObject classes (ie. when an XObject of a given XClass is added/updated or removed).
* This would cover for example the Comment use case. A user should be able to say the she/he wants to be notified when a Comment is added / modified or deleted.
* In order to merge the Watchlist feature, don’t forget that for each Event type, you need to include the ability for the user to decide what part of the wiki it concerns. Examples:
** Receive notifications for Blog A (but not Blog B)
** Receive page notifications for all pages under that page
** Receive comment notifications for all comments done in pages in that wiki only

This last point is important and means that we probably need to modify the current notifications UI on the user profile page to be able to add includes/excludes for each event type. We may also need to have a UI similar to the Watchlist one that allows you to watch the current page/space/wiki but possibly done more generically, allowing you to choose the event types too. If we had both types of UI the user would be able to set his/her notifications from 2 angles:
* select the event type and then the scope
* select the scope and then the even type

I have the feeling that both are interesting, depending on the situation.

WDYT?

Thanks
-Vincent

> Thanks,

[snip]

Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [Proposal] Improve the Notifications Module to replace the Watchlist

Guillaume Delhumeau
2017-04-10 20:45 GMT+02:00 Vincent Massol <[hidden email]>:

> Hi Guillaume,
>
> > On 10 Apr 2017, at 17:34, Guillaume Delhumeau <
> [hidden email]> wrote:
> >
> > Hello developers!
> >
> > The new roadmap has been voted and I continue my work on the
> notifications
> > module. You might have played with it since the 9.2 release and I hope
> you
> > like it.
> >
> > Now I need to implement the email part of the notifications module. It
> > means that users could decide either the notifications are displayed on
> the
> > top menu or sent by emails periodically.
>
> I don’t think it’s “either”. IMO they could have both at the same time.
>

I wanted to "simplify" my message in order to not have a complicated
thread, but indeed I also consider having both :)


>
> Also it shouldn’t have to be only periodically; it’s important to include
> the realtime notification too.
>

OK.


>
> > Having this in mind, it is clear
> > that it conflicts with the Watchlist.
> >
> > The plan is to move to contrib the Watchlist application (when possible)
> > and to implement the same features inside the notifications module.
> >
> > Any objection before I start the work?
>
> Sounds good to me. The Notifications module should encompass all features
> from AS and Watchlist IMO.
>
> Various ideas:
> * From an architecture POV I think we should have some generic way to be
> able to subscribe to notifications by XObject classes (ie. when an XObject
> of a given XClass is added/updated or removed).
>

It's indeed a good idea that you have also proposed in order to simplify
the way a developer can push notifications:
https://jira.xwiki.org/browse/XWIKI-14119



> * This would cover for example the Comment use case. A user should be able
> to say the she/he wants to be notified when a Comment is added / modified
> or deleted.
>

For the comment use case, I don't really want to change the way it is
currently implemented. It is done by the Activity Stream for years, and I
prefer re-using what exists.


> * In order to merge the Watchlist feature, don’t forget that for each
> Event type, you need to include the ability for the user to decide what
> part of the wiki it concerns. Examples:
> ** Receive notifications for Blog A (but not Blog B)
> ** Receive page notifications for all pages under that page
> ** Receive comment notifications for all comments done in pages in that
> wiki only
>

Sure, I have created an issue for this:
http://jira.xwiki.org/browse/XWIKI-14199


>
> This last point is important and means that we probably need to modify the
> current notifications UI on the user profile page to be able to add
> includes/excludes for each event type. We may also need to have a UI
> similar to the Watchlist one that allows you to watch the current
> page/space/wiki but possibly done more generically, allowing you to choose
> the event types too. If we had both types of UI the user would be able to
> set his/her notifications from 2 angles:
> * select the event type and then the scope
> * select the scope and then the even type
>

The second angle might be more complicated to implement. How do you select
the scope? By using a tree picker? A livetable? What if you select a sub
page of a page that is already followed, do we display the inheritance?


>
> I have the feeling that both are interesting, depending on the situation.
>
> WDYT?
>
> Thanks
> -Vincent
>
> > Thanks,
>
> [snip]
>
>
Thanks for your answer,

--
Guillaume Delhumeau ([hidden email])
Research & Development Engineer at XWiki SAS
Committer on the XWiki.org project
Loading...