✅[outreachy] Registry : Add to favorites #5447 #5451

mailsg · 2024-10-21T18:38:18Z

Fixes

Fixes [outreachy] Registry: Add to favorites #5447 by @svrnm

Description

This PR introduces a "Add to Favorites" feature, allowing users to quickly mark registry entries as favorites. Favorites are stored locally in local storage, ensuring persistence across sessions.
- Implemented a button for adding/removing items from favorites.
- Favorites are stored in local storage for better user experience.
- Integrated the functionality using a favorite-btn that updates dynamically.

Technical details

Partial for JavaScript: Moved JavaScript functionality to a separate js/addToFavorites.js file, loaded via a partial in the layout for better maintainability and performance.
Local Storage Logic: The local storage checks if an item is already marked as a favorite, and updates the button's appearance accordingly. This avoids the need for server-side calls, keeping it fast and client-side focused.

Screenshots

linux-foundation-easycla · 2024-10-21T18:38:25Z

The committers listed above are authorized under a signed CLA.

✅ login: mailsg / name: Sandeep Ghosh (c99bcb5, 92cd36c, a55c92a, 8017aea, d8b663b, ff3ad9b, 38d39b3, 986eba4, 10c1ee4)

Asked to merge during PR checks.

svrnm · 2024-10-22T08:30:46Z

~~@mailsg: I see that I can add favorites, have you planned any way that I can use the favorites, e.g. only see the favorites or any other way?~~

@mailsg, I don't have a registration from you as a contributor in the outreachy platform. Since I have closed the project, I will close your isse and PR. Thank you for participating in outreachy!

svrnm · 2024-10-22T11:04:42Z

@mailsg please make sure that you register with the outreachy platform after that I will provide a review

svrnm · 2024-10-23T07:29:57Z

thanks for registering your contributions in the outreachy platform. Following up with my previous feedback:

I see that I can add favorites, have you planned any way that I can use the favorites, e.g. only see the favorites or any other way?

mailsg · 2024-10-23T12:28:15Z

thanks for registering your contributions in the outreachy platform. Following up with my previous feedback:

I see that I can add favorites, have you planned any way that I can use the favorites, e.g. only see the favorites or any other way?

Hi @svrnm,

In addition to providing users with the ability to add and remove items from their favorites, there are several practical ways to make this feature more useful. These can be the planned usage of the Add to Favorites feature :

Dedicated "Favorites" Page
- Users will be able to view all of their favorite marked items in one place by navigating to a dedicated "Favorites" page. This page will aggregate all marked items for easy access.
- This allows users to quickly locate their preferred resources without having to search through the entire registry each time.
Filter by Favorites
- An additional filter could be added to the registry that allows users to view only their favorite marked items while browsing the main catalog. This would integrate the favorites functionality directly into the registry interface, making it more user-friendly and efficient for users looking to engage with their curated resources.
Persistence Across Sessions
- Since the favorites are stored in local storage or session cookies, users can access their list of favorites even after logging out or closing the browser. This ensures that the favorites list persists across sessions, improving the user experience by providing continuity.
Improved Personalization
- With a user's favorites data available, the site could later introduce personalized content suggestions based on their favorites, such as related tools, newly added components, or relevant updates. This could lead to better user satisfaction and engagement without requiring significant changes to the initial feature implementation.
Future Expansions
- In the future, favorites could serve as the foundation for more advanced features, such as exporting favorite lists, sharing with others, or receiving notifications when an item in their favorites is updated. These expansions would make the feature even more valuable to users while aligning with the overall goal of improving user experience.

To conclude, the Add to Favorites feature is designed to make the registry more user-friendly and personalized. By giving users a dedicated page for their favorites, a filter to view only their selected items, and ensuring everything is saved across sessions, we are making it easier for users to engage with the platform in a way that works for them. This will not only make the registry more useful on a day-to-day basis, but it also sets the stage for future improvements like personalized recommendations or sharing favorites with others. Overall, I think this can be a step towards making the site more interactive and valuable for the community.

Thanks.

svrnm · 2024-10-23T13:37:54Z

Please implement "Filter by Favorites". Thanks.

merged the main branch to implement filter by favorites.

mailsg · 2024-10-23T17:25:30Z

Please implement "Filter by Favorites". Thanks.

Description

The JavaScript functionality enhances user interaction with the registry by allowing users to filter their view to display only their favorite entries. This feature simplifies navigation by letting users focus on items they are most interested in.

Technical details

The implementation consists of event listeners that manage user interactions with the Show Favorites button. When a user selects to view only their favorites, the system checks against local storage to display the appropriate items and toggling Show Favorites to Show All.
When the user selects Show All, they can view all the registry items.

Thanks.

svrnm

overall lgtm, a few comments

svrnm · 2024-10-24T09:19:59Z

.htmltest.yml

+  - ^blog/(\d+/)?page/\d+
  # TODO drop next line after https://github.com/open-telemetry/opentelemetry.io/issues/5423 is fixed for ja pages:
  - ^ja/docs/concepts/instrumentation/libraries/
  # TODO drop next line after https://github.com/open-telemetry/opentelemetry.io/issues/5423 is fixed for pt pages:
  - ^pt/docs/concepts/instrumentation/libraries/
-  - ^blog/(\d+/)?page/\d+


please revert this change

svrnm · 2024-10-24T09:20:47Z

assets/js/addToFavorites.js

+      } else {
+        favorites.push(registryId);
+        localStorage.setItem('favorites', JSON.stringify(favorites));
+        button.innerHTML = '<i class="fa-solid fa-star"></i>';


Remove from favorites to make it clear that it is a favorite and can be removed by clicking on the star once again

merge main to update the brach for implementing suggested review

merge with main to update the branch.

mailsg · 2024-10-24T10:29:12Z

overall lgtm, a few comments

Hi @svrnm,

I have made the suggested changes.

Thanks.

svrnm · 2024-10-24T12:59:04Z

I consider this as done! After the outreachy application phase we will take another look and see if we can merge this PR. Thank you!

svrnm · 2024-12-11T13:54:50Z

I will close this for now, since I raised a follow up discussion here: #5759

if you are interested in continuing contributing, please take a look! If we agree to build this, you can give it a try!

Thanks

Registry : Add to favorites open-telemetry#5447

c99bcb5

mailsg changed the title ~~Registry : Add to favorites #5447~~ [WIP] Registry : Add to favorites #5447 Oct 21, 2024

run and fix pull request checks

92cd36c

mailsg marked this pull request as ready for review October 21, 2024 18:51

mailsg requested a review from a team as a code owner October 21, 2024 18:51

mailsg added 2 commits October 21, 2024 19:03

Merge branch 'main' into registry-add-to-favorites

a55c92a

Asked to merge during PR checks.

merge the main branch asked during checks

d8b663b

mailsg changed the title ~~[WIP] Registry : Add to favorites #5447~~ Registry : Add to favorites #5447 Oct 21, 2024

svrnm added the outreachy Issues for Outreachy Participants label Oct 22, 2024

svrnm changed the title ~~Registry : Add to favorites #5447~~ [outreachy] Registry : Add to favorites #5447 Oct 22, 2024

svrnm closed this Oct 22, 2024

svrnm reopened this Oct 22, 2024

mailsg added 2 commits October 23, 2024 14:35

Merge branch 'main' into registry-add-to-favorites

10c1ee4

merged the main branch to implement filter by favorites.

implement filter by favorites extending add to favorites

ff3ad9b

svrnm requested changes Oct 24, 2024

View reviewed changes

mailsg added 3 commits October 24, 2024 09:34

Merge branch 'main' into registry-add-to-favorites

8017aea

merge main to update the brach for implementing suggested review

implement changes to display Remove from Favorites

986eba4

Merge branch 'main' into registry-add-to-favorites

38d39b3

merge with main to update the branch.

mailsg requested a review from svrnm October 24, 2024 10:31

svrnm changed the title ~~[outreachy] Registry : Add to favorites #5447~~ ✅[outreachy] Registry : Add to favorites #5447 Oct 24, 2024

svrnm mentioned this pull request Dec 11, 2024

Registry "build your configuration" option #5759

Open

svrnm closed this Dec 11, 2024

svrnm added registry and removed outreachy Issues for Outreachy Participants labels Dec 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✅[outreachy] Registry : Add to favorites #5447 #5451

✅[outreachy] Registry : Add to favorites #5447 #5451

mailsg commented Oct 21, 2024 •

edited

Loading

linux-foundation-easycla bot commented Oct 21, 2024 •

edited

Loading

svrnm commented Oct 22, 2024 •

edited

Loading

svrnm commented Oct 22, 2024

svrnm commented Oct 23, 2024

mailsg commented Oct 23, 2024

svrnm commented Oct 23, 2024

mailsg commented Oct 23, 2024

svrnm left a comment

svrnm Oct 24, 2024

svrnm Oct 24, 2024

mailsg commented Oct 24, 2024

svrnm commented Oct 24, 2024

svrnm commented Dec 11, 2024 •

edited

Loading

✅[outreachy] Registry : Add to favorites #5447 #5451

✅[outreachy] Registry : Add to favorites #5447 #5451

Conversation

mailsg commented Oct 21, 2024 • edited Loading

Fixes

Description

Technical details

Screenshots

linux-foundation-easycla bot commented Oct 21, 2024 • edited Loading

svrnm commented Oct 22, 2024 • edited Loading

svrnm commented Oct 22, 2024

svrnm commented Oct 23, 2024

mailsg commented Oct 23, 2024

svrnm commented Oct 23, 2024

mailsg commented Oct 23, 2024

Description

Technical details

svrnm left a comment

Choose a reason for hiding this comment

svrnm Oct 24, 2024

Choose a reason for hiding this comment

svrnm Oct 24, 2024

Choose a reason for hiding this comment

mailsg commented Oct 24, 2024

svrnm commented Oct 24, 2024

svrnm commented Dec 11, 2024 • edited Loading

mailsg commented Oct 21, 2024 •

edited

Loading

linux-foundation-easycla bot commented Oct 21, 2024 •

edited

Loading

svrnm commented Oct 22, 2024 •

edited

Loading

svrnm commented Dec 11, 2024 •

edited

Loading