Gamification events for news/notes

[Julien-Dubois-eXo]

Rationale

Since News and Notes have been merged to use one editor, we have several issues to address:

1. The events related to News are not available for Meeds Package (available only using eXo package)
   • As the 'News' feature is listed for any Meeds Platform
   • It must be available for meeds package (and only for it to avoid redundancy)
2. When creating a news, it is triggered too as an event for creating a note (using eXo)

Additionally, the usecase of publishing a content (news/notes) is not currently suggested for gamification while it can be more than interesting.

1. Functional Requirements

Top User Stories

Gamification Events for News/Notes usecases

As a program owner, I must be able to create below listed actions for Content:

Actions already available and to keep

• Create a note
• Update a note

For those events, we must ensure this is only considered when a note is created or updated depending on the case. Indeed, news creation or update must not been considered here.

New actions to suggest

1. Post Content in Feed

Business rules:

• Usecase: An article or a note is posted using the option "Post in feed" selected
• Consider the event ONLY once the content is posted/published in case of scheduling
• Cancellation cases = Activity hidden/deleted OR Option "Post in feed" updated to 'FALSE'
• Precision: It must be possible to identify for this event where the content has been posted

Event Definition:

• Name: Post Content
• Description: Post a note or an article in a feed

2. Publish Content into a news list

Business rules:

• Usecase: An article or a note is published using "Publish in a news list" AND "a target is selected"
• 1 Event considered by target where the content has been published
• Consider the event ONLY once the content is posted/published in case of scheduling
• Cancellation cases = Activity hidden / deleted OR Option "Publish in news list" updated to "FALSE" OR Target Removed

Event Definition:

• Name: Publish Content in Newslist
• Description: List a note or an article in a newslist

Precisions:

• If a note is listed in a newslist, do not consider the event twice for note and news. Same behaviour for a news referred in a note tree.
• No event should be detected when I only create an article or an SNV.

Creation of the action

While creating the action, I must be able to identify for following event where the content has been written:

• Any space
• Only written from a space

Impacts

Gamification

Notifications

Analytics

Unified Search

2. Technical Requirements

Expected Volume & Performance

Security

Extensibility

Configurability

Upgradability

Existing Features

Feature Flags

Property Name	Default Value	Target Audience	Functional Behaviour

Other Non Functional Requirements

3. Impacts

Documentation

Training

4. Software Architecture

Security

Access

• GUI
• API

Services & processing

• Ex: Scheduled Jobs

Data and persistence

• Macro data model
• Persistence layer
• Use of caches

Clustering

Multitenancy

Integrations

Migration strategy

5. Annexes

• Reasoning that explain the technical choices
• Impacts
• References

[Julien-Dubois-eXo]

@margondicco after reflection and discussion with @srenault-meeds it's better to have common events for the publication around note and news. It will be too complicated if we separate them.

Is it fine for you?

[Julien-Dubois-eXo]

@srenault-meeds ready to review for Go-func, please?

[srenault-meeds]

Go Fonc :)

[srenault-meeds]

@margondicco @Julien-Dubois-eXo I think two events are missing:
Open a note/news
Read a note/news

[margondicco]

@margondicco @Julien-Dubois-eXo I think two events are missing:
Open a note/news
Read a note/news

it coud be interesting but please on another improvement. Thank you

[srenault-meeds]

I have removed the Go-Func for now as it has been moved back to draft status