search

SAP / knowledge-hub-extension

A collaborative project driven by the SAP development community to build and enhance a Visual Studio Code extension that aggregates SAP development resources (tutorials, blogs, walkthroughs, and more) in the user's development environment.
Apache License 2.0
5 stars 2 forks source link

FEATURE - Introduce ability to save Favorites in Blogs and Tutorials tabs #86

Open cjbernal opened 1 year ago

cjbernal commented 1 year ago

As a Knowledge Hub user, I want to save blogs and tutorials that are interesting to me, so that I read/use them later without having to search again

Description

Users may have articles or blogs they have discovered via Knowledge Hub that they wish to return to later -- either because they use the contents frequently or they didn't have time to start/finish the content. We can simplify their experience of finding the materials again by allowing users to save them as a "Favorite".

Technical Design

What modules need to be created or enhanced? How would the functionality be exposed and how can it be consumed?

Acceptance Criteria

GivenWhenThen format (https://martinfowler.com/bliki/GivenWhenThen.html)

Given I have the blogs/tutorials tab open with content displayed when I click the Favorites icon next to a blog/tutorial then that piece of content will be saved in a favorites list to be referred to later.

Given I have previously saved contents for my Favorites list when I click on the button/tab to open the Favorites list then a list of content that I have previously marked as a Favorite will be displayed.

Given I have the Favorites list open when I click on content that has been saved in the Favorites list then the content will open in the browser.

Notes

Tasks

gpeuc commented 1 year ago

Alright, we have some general idea how this would work (little stars at various objects, and then we expose this later somewhere), but can we first get some tech confirmation that this would work?

We most likely need some local storage, where IDs are stored. Blog post ID, and Tutorial ID, and later we read them in the Favourites section, or something like that. But can we first get some confirmation that this works, and then we will go into UI of it?

cjbernal commented 1 year ago

@gpeuc We should wait for @eouin to confirm, but this was briefly discussed in team grooming -- we already locally store tags so that they are retained when the user reopens Knowledge Hub. But if there is something else we need to consider, Ed would definitely be the person for that :-)

gpeuc commented 1 year ago

@eouin @cjbernal I'd like that we get some tech confirmation on how could this be done. Are we just saving IDs, and then when we render Fav tab we pull from Blogs those IDs in order to get title and other metadata. Or do we maybe have to save some of the metadata (hard-code save it) when users press the ⭐ button?

If it's as simple as us storing IDs, and based on those we can on-the-fly pull whatever we need from those entities, then we are good to go. But I'd like someone to confirm that is indeed the case.

I do see that we are using some IDs already to link to Blogs - https://blogs.sap.com/?p=1729704 - so is that it? We save 1729704 and we can later get everything from that?

eouin commented 1 year ago

@gpeuc At the moment we are saving an array of object made with id's and a description text. We can do the sane for favorite entries.