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

Analytics improvements for notes and news #162

Open
Julien-Dubois-eXo opened this issue Oct 3, 2024 · 12 comments
Open

Analytics improvements for notes and news #162

Julien-Dubois-eXo opened this issue Oct 3, 2024 · 12 comments

Comments

@Julien-Dubois-eXo
Copy link

Julien-Dubois-eXo commented Oct 3, 2024

Rationale

After the fusion of News to notes, we need to harmonize the analytics. Currently, there are 2 different measuring points to track the notes and news.

  • Content
  • Notes

With some actions on notes/news, both measuring points are detected. So we have a misunderstanding on the analysis.

1. Functional Requirements

Top User Stories

As analytics/admin or platform/admin or space admin with access to analytics

Create Content measuring point
When a note/article/SNV is created
Then I have a measuring point "Create Content". The existing "Create Content" should be adapted as follows:

  • Title: I have the displayed title of the note and news so it's updated if the name is changed
    • For SNV: SNV in {page_name}
  • Type: Note or News or SNV according to the content type
    We will remove this attribute:
  • Publication
  • Audience

Publish Content measuring point_
When a note/article is published = each time the publication options are saved and we have at least one of "posted in the feed or published in a news list"
Then I have a new measuring point "Publish Content" with the following attributes:

  • Content: Title: I have the displayed title of the note and news so it's updated if the name is changed
  • Social: User ID: avatar and name of the user who did the publication
  • Content: Creator: the user who created the article
  • Content: Type: Note or News according to the content type
  • Social: Space ID: avatar and name of the space from where the article/note is published
  • Content: Publishing targets: the list of the targets selected if selected. We should be able to filter on a value of the attribute. To evaluate if technically possible.
  • Content: Feed publication: Yes or No (= if the article is published in the feed or not)
  • Content: Scheduling: start date, end date or both
  • Content: Hide author: Yes or No according to the option
  • Content: Hide reaction: Yes or No according to the option

View Content measuring point
When a note/article/SNV is consulted
Then I have a measuring point "View Content". The existing "View Content" should be adapted as follows:

  • Content: Title: I have the displayed title of the note and news so it's updated if the name is changed
    • For SNV: SNV in {page_name}
  • Content: Language: the language version consulted
  • Content: Creator: user name and avatar of the user who created the note/News/SNV
  • Content: Last author: user name and avatar of the last user who edits the note or article
  • Content: Type: Note or News or SNV according to the content type

Update Content measuring point
When a note/article/SNV is edited
Then I have a measuring point "Update Content". The existing "Update Content" should be adapted as follows:

  • Content: Title: I have the displayed title of the note and news so it's updated if the name is changed
    • For SNV: SNV in {page_name}
  • Content: Type: Note or News or SNV according to the content type
  • Content Creator: user name and avatar of the user who created the note/News/SNV
  • Content: Language: the language version edited

We will remove:

  • Publication
  • Audience

Delete Content measuring point
When a note/article/SNV is deleted
Then I have a measuring point "Delete Content". The existing "Delete Content" should be adapted as follows:

  • Content: Title: I have the displayed title of the note and news so it's updated if the name is changed
  • For SNV: SNV in {page_name}
  • Content : Type: Note or News or SNV according to the content type
  • Content: Creator: the user who created the article
  • Content: Last author: the last user who edited the article

We will remove:

  • Publication
  • Audience

Like Content measuring point
When an article is liked from the feed or the news detail
Then I have a measuring point "Content liked". The existing "Content liked" should be adapted as follows:

  • Content: Title: I have the displayed title of the note and news so it's updated if the name is changed
  • Content: Creator: the user who created the article
  • Content: Last author: the last user who edited the article
  • Content: language: the language version consulted

We will remove:

  • Publication

Content shared measuring point
When an article is shared from one space to another
Then I have a measuring point "Content shared". The existing "Content shared" should be adapted as follows:

  • Content: Title: I have the displayed title of the note and news so it's updated if the name is changed
  • Content: Creator: the user who created the article
  • Content: Last author: the last user who edited the article

We will remove:

  • Publication

Impacts

Analytics

Note measuring point
The measuring point related to Notes will be removed:

  • Note created
  • Note updated
  • Note delete
  • Get note from treeview
  • Get note from breadcrumb

The module Notes will be removed.

Create activity measuring point

  • The note/article creation will no longer generate a measuring point "Create activity" as it's followed by the measuring point "Publish content".

Comment activity measuring point_
When the activity of an article is commented on the feed or the article detail
Then we should no longer have a measuring point "Comment activity" for that.

Like activity measuring point_
When the activity of an article is liked on the feed or the article detail
Then we should no longer have a measuring point "Activity liked" for that.

Content analysis report
The report "Content analysis" will be empowered with the analysis of notes. I should be able to analyze the view of Notes in the report. We will no longer display the deleted contents.

Report using activities update
The activities related to Notes will be included in the module Content so activities around articles and notes will be grouped. So the following reports will be updated to add the "Create content", "Update content", "Publish content", "Content liked", "Content commented", "Content shared" and "Delete content":

  • Activity
  • % of activity done by 10% of active users
  • space analysis
  • user analysis

2. Technical Requirements

Expected Volume & Performance

Security

No modification. We add/update/remove analytics measure points

Extensibility

We will create a new SampleItem extension to display the title of a content.
The content id will be stored in the measure point, and the extension will read the title of the content.
So we will be able to display the modified title of a content

Configurability

Upgradability

Existing analytics will not be updated.

Existing Features

Feature Flags

No feature flag planned

Property Name Default Value Target Audience Functional Behaviour

Other Non Functional Requirements

3. Impacts

Documentation

Training

4. Software Architecture

Security

No modification

Access

  • GUI
  • API

Existing listeners for content and notes analytics will be removed if necessary, and updated fro the others

Services & processing

  • Ex: Scheduled Jobs
    A new listener for measure point PublishContent will be added.

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 Julien-Dubois-eXo self-assigned this Oct 3, 2024
@github-project-automation github-project-automation bot moved this to Open in MIP Board Oct 3, 2024
@azayati azayati removed their assignment Nov 6, 2024
@Julien-Dubois-eXo Julien-Dubois-eXo changed the title News to notes - part 7 - unified search, News app search, gamification and analytics News to notes - part 7 - Analytics improvements for notes and news Nov 22, 2024
@Julien-Dubois-eXo Julien-Dubois-eXo changed the title News to notes - part 7 - Analytics improvements for notes and news Analytics improvements for notes and news Nov 22, 2024
@Julien-Dubois-eXo
Copy link
Author

@margondicco could you please check it before I request the review by Meeds?

@margondicco
Copy link

margondicco commented Nov 30, 2024

@Julien-Dubois-eXo

The activities related to Notes will be included in the module Content so activities around articles and notes will be grouped together. So the following reports will be updated to add the "View Content", "Create content", "Update content" and "Delete content":

Not the view content operation : it is not an activities but just a view

Then I have a new measuring point "Publish Content" with the following attributes:
we must have audience type :

  • for the Publishing targets ; IMO a nice to have. The purpose : we should filter by target. It could be complicated.

% of activity done by 10% of active users

we must redefine the whole settings of this report.

Image

@Julien-Dubois-eXo
Copy link
Author

% of activity done by 10% of active users

we must redefine the whole settings of this report.

@margondicco can we treat this point as an issue instead of including it in the MIP?

To evaluate:

  • Add automatically in measuring an attribute "Profile attribute" (with field distinction) if the attribute Social: User ID is present in the operation.

Same for this point as it's not related to Content analysis.

@Julien-Dubois-eXo
Copy link
Author

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

The points in my previous message will be treated with separate issues.

@Julien-Dubois-eXo Julien-Dubois-eXo moved this from Open to Submitted in MIP Board Dec 4, 2024
@srenault-meeds
Copy link
Member

Hello,

My feedbacks:

Type: Note or News or SNV according to the content type

How do you consider a note being posted to the stream or published to a target? A news? Or still a note?

Publishing targets: the list of the targets selected if selected. We should be able to filter on a value of the attribute. To evaluate if technically possible.

How do you plan to display the targets in the samples and in the analytics table?

The module Notes will be removed.

Do you plan to rename the module News "Content" then?

Name of the content (AKA title)

How do you manage content being deleted?
Currently, it is marked as deleted which is bad UX
And BTW it will be something redundant with SNV that can be deleted
Suggestion: don't list it except it is requested in the analytics settings

Name of the content (AKA title) for SNV

What do you take for SNV's title? Indeed, no title is needed for SNV

@Julien-Dubois-eXo
Copy link
Author

The module Notes will be removed.
Do you plan to rename the module News "Content" then?

Why not, I need to analyze the impact.

The other points are updated in the description.

@srenault-meeds
Copy link
Member

Ok, go fonc

@Julien-Dubois-eXo
Copy link
Author

@rdenarie can you complete the technical part, please?

@Julien-Dubois-eXo
Copy link
Author

Julien-Dubois-eXo commented Jan 10, 2025

@srenault-meeds I identified other improvements during US redaction. Here are the modifications done:

Create Content measuring point

We will remove this attribute:
Publication
Audience

Publish Content measuring point

Content: Creator: the user who created the article

Update Content measuring point

We will remove:

  • Publication
  • Audience

Add the

  • Delete Content measuring point
  • Like Content measuring point
  • Content shared measuring point

On analytics impact add the:

Comment activity measuring point_
When the activity of an article is commented on the feed or the article detail
Then we should no longer have a measuring point "Comment activity" for that.

Like activity measuring point_
When the activity of an article is liked on the feed or the article detail
Then we should no longer have a measuring point "Activity liked" for that.

Content analysis report
The report "Content analysis" will be empowered with the analysis of notes. I should be able to analyze the view of Notes in the report. We will no longer display the deleted contents.

Report using activities update

"Publish content", "Content liked", "Content commented", "Content shared"

@srenault-meeds
Copy link
Member

ok

@rdenarie
Copy link
Member

rdenarie commented Feb 7, 2025

Technical spect added, readuy for review cc @boubaker

@boubaker
Copy link
Member

boubaker commented Feb 7, 2025

ok for me. Go tech

@boubaker boubaker moved this from Submitted to Accepted in MIP Board Feb 7, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 17, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 17, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 17, 2025
hakermi added a commit to Meeds-io/content that referenced this issue Feb 17, 2025
hakermi added a commit to Meeds-io/content that referenced this issue Feb 17, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 17, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 17, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 17, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 17, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 17, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 17, 2025
hakermi added a commit to Meeds-io/content that referenced this issue Feb 17, 2025
exo-swf pushed a commit to Meeds-io/notes that referenced this issue Feb 18, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 18, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 18, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 18, 2025
hakermi added a commit to Meeds-io/notes that referenced this issue Feb 18, 2025
exo-swf pushed a commit to Meeds-io/notes that referenced this issue Feb 18, 2025
exo-swf pushed a commit to Meeds-io/notes that referenced this issue Feb 18, 2025
exo-swf pushed a commit to Meeds-io/content that referenced this issue Feb 18, 2025
exo-swf pushed a commit to Meeds-io/content that referenced this issue Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Accepted
Development

No branches or pull requests

6 participants