News to notes - Part 3 - Metadata, notes display revamping and multilingual

Julien-Dubois-eXo commented 2 months ago

Rationale

Harmonization of Notes and News feature.

1. Functional Requirements

Common Editor improvement

Unification of editor for News based on Note editor

the News editor will be based on the note editor

Metadata

Common metadata drawer between notes and news to add complementary information to the content
Metadata drawer available from the editor
Metadatas:
- Featured image
- Summary
- I can add emoji and tags
All the metadata should be changed according to the translation choice

Translation

Add the translation option for the news

Mobile editor harmonization

No metadata button in mobile
Add a X to close the editor and going back to the page where we open the editor
Switch to display the edition options in 2 parts
Only layout options:
- bold
- italic
- bullet list
- number list
- quote

Other small improvement

be able to mention a user in a note or news
Be able to add emoji on the title
Be able to create a news or note with the same title, no matter the location on the treeview or the space
Save button harmonization
Save button UX improvement : no more close of the editor
- Notes: success snackbar with the possibility to view the notes
- News:
  - creation:
  - Before first publication: open the publication drawer and after publication a success snackbar with the possibility to view the articles.
  - After the first publication: we display a save button and no more publication drawer.
  - edition: save button and success snackbar
Remove Cancel button for news case
Change the header editor image to replace with a font awesome icon.
Same modification will be applied on SNV editor. We will use notes editor for SNV

Design for Note and SNV editor Creation

Edition

Design for News editor Creation Before first publication

After first publication

Edition

Notes

Expand drawer for the treeview
UI revamping of the 3 dots menu

Note display revamping to being able to display the Metadata Note - Title and body

Note - Title, body + summary

Note - Title, body + featured image

Note - Title, body + featured image + summary

Translation

News

Display translation during the News consultation

News list

Integrate the translation component into the News list title
Allow emoji on the title of a news list
Display translation on the content of the news list (article title, summary and cover) according to user language settings

Stream

Display translation of the post for News (title, summary and cover) according to user language settings

2. Technical Requirements

Expected Volume & Performance

Data volumetry will be changed since eventual metadatas will be stored for created notes.

Extensibility

The notes editor should be extensible in order to be customized for News case.

Upgradability

We should springify existing service & rest layers

Existing Features

A new "metadatas" button should be added for notes editor in order to open the metadatas drawer .
The save button of notes editor should open the publication drawer in case of News creation.

Feature Flags

News editor unification
- Value: exo.feature.contentUnifiedEditor.enabled
- Default value: false
- True: It's the new News editor (note editor) that is opens when editing or creating a news
- False: It's the old news editor that is opened when editing or creating a news
- Target audience: All users
- To remove at the end
Metadata
- Value: metadatasDrawer
- Default value: false
- True: Display the metadata button on editor and display new Notes layout when opening note app
- False: Hide the metadata button on editor and and display old Notes layout when opening note app
- Target audience: All users
- To remove at the end
Translation for news
- Value: newsTranslation
- Default value: False
- True: Click on the Translation button opens the translation dropdown.
- False: Click on the Translation button activate/desactivate the automatic translation
- Target audience: All users
- To remove at the end
Translation for Newslist header
- Value: newsListTranslation
- Default value: false
- True: Display the translation button in the News list settings
- False: Hide the translation button in the News list settings
- Target audience: All users
- To remove at the end

4. Software Architecture

Access

GUI
- Metadata drawer should be implemented
API
- Content rest services should be cleaned after editor unification.

Services & processing

Notes services should be updated based on content services in order to store additional metadatas.
Content services should be cleaned after editor unification.

Julien-Dubois-eXo commented 1 month ago

@srenault-meeds I have updated the description and added screenshots according to the last discussion. Ready to review for the functional part. @azayati ready to complete the technical part too.

srenault-meeds commented 1 month ago

Thanks @Julien-Dubois-eXo

Feedbacks:

All the metadata should changed according to the translation choice

Do you mean including banner?

Cover name

Cover looks like a wrong name as it is also used for newslist, and for news avatar in the activity. Can we use thumbnail instead?

Mobile view: Not all edition options displayed:

We discussed about it and I thought that we minimize the effort to use only the options we have for SNV mobile view. Can we start that way for now? And then, we gather real feedbacks.

Title

Make sure we can use emojis for news title please. We have made it available for notes few days ago.

srenault-meeds commented 1 month ago

Cover name

I suggest Featured Image Wordpress or Medium used that for their "banner / thumbnail / cover"

srenault-meeds commented 1 month ago

@Julien-Dubois-eXo Have you seen my previous comments?

Julien-Dubois-eXo commented 1 month ago

All the metadata should changed according to the translation choice

Do you mean including banner?

Yes

Mobile view: Not all edition options displayed:

We discussed about it and I thought that we minimize the effort to use only the options we have for SNV mobile view. Can we start that way for now? And then, we gather real feedbacks.

I just kept the options you asked for during the session but as you want. @margondicco is it fine for you?

Title

Make sure we can use emojis for news title please. We have made it available for notes few days ago.

Ok

Cover name

I suggest Featured Image Wordpress or Medium used that for their "banner / thumbnail / cover"

@margondicco you want the term cover. I let you answer. No objection from my side.

margondicco commented 1 month ago

Cover name

I suggest Featured Image Wordpress or Medium used that for their "banner / thumbnail / cover"

no objection

margondicco commented 1 month ago

@Julien-Dubois-eXo could you update the image in the description ?

Thank you

margondicco commented 1 month ago

Make sure we can use emojis for news title please. We have made it available for notes few days ago.

and summary please

srenault-meeds commented 1 month ago

ok @Julien-Dubois-eXo let me know once ready to review

Julien-Dubois-eXo commented 1 month ago

@srenault-meeds ready to review

srenault-meeds commented 1 month ago

Hello @Julien-Dubois-eXo

Thanks.

Feedbacks:

Be able to add emoji on the title

And for summary ;-)

After the first publication: we display a save button and no more publication drawer.

But can we update the publication once published?

Additional question: Do you plan analytics review to merge between notes / news? Do you plan adding gamification items for using news, publishing it, getting the note read, bookmarked, etc.? Regarding notification, is there anything planned? Indeed, notifications for news are for example deactivated by default for existing users

Julien-Dubois-eXo commented 1 month ago

And for summary ;-)

Yes it's planned.

But can we update the publication once published?

Yes as it's already the case by using the option dedicated to that in the 3 dots.

Do you plan analytics review to merge between notes / news? Do you plan adding gamification items for using news, publishing it, getting the note read, bookmarked, etc.?

It's not part of the scope for the moment. We will check the impact of the migration and see after that.

Regarding notification, is there anything planned? Indeed, notifications for news are for example deactivated by default for existing users

Some rework of news notification is planned. It will be descripted in the MIP dedicated to the publication.

srenault-meeds commented 1 month ago

Ok thanks. Go-Fonc

Julien-Dubois-eXo commented 1 month ago

@srenault-meeds updated to include the rule about note/news creation with a same title

Be able to create a news or note with the same title, no matter the location on the treeview or the space

srenault-meeds commented 1 month ago

ok thanks!

Julien-Dubois-eXo commented 3 weeks ago

@srenault-meeds FYI we will add a FF to unify the News editor with the Notes editor. The description was updated in that way.

srenault-meeds commented 3 weeks ago

@srenault-meeds FYI we will add a FF to unify the News editor with the Notes editor. The description was updated in that way.

Why a FF? Why not improving it once for all?

Julien-Dubois-eXo commented 3 weeks ago

@srenault-meeds to be able to correctly manage the delivery. At the end the FF we will be removed it as mentioned in the specification.

srenault-meeds commented 3 weeks ago

ok

azayati commented 2 weeks ago

@boubaker technical part ready to be checked.

boubaker commented 2 weeks ago

ok for me

Meeds-io / MIPs