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

Put items into sections #5348

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Beccamak
Copy link
Contributor

@Beccamak Beccamak commented Oct 8, 2024

#5317
@svrnm I have created sections for the major categories on the registry page.
For view all links, I had to use the search functionality that was already implemented. Initially, I thought that on the backend, there was an identifier or tag for entries that easily identifies them as plugins, libraries, or instrumentations. The plan was to have all these categories filtered out and then on clicking "view all" they are populated.

However, after some interactions with the codebase, I didn't see that there. I noticed that if I had to get a category out (for example, the libraries), it had to be through a search (the fuzzy search the system is using), and I couldn't find a way of passing the filtered results back to the template, which I think explains why the whole entries were initially inserted on the registry page. The keys were compared to filter out the keys (entries) that didn't match the keys (entries) in the returned search results on the DOM.

Kindly let me know your thoughts on this.

@Beccamak Beccamak requested a review from a team as a code owner October 8, 2024 13:32
Copy link

linux-foundation-easycla bot commented Oct 8, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

Copy link
Member

@svrnm svrnm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a really good start, thank you.

A few inline comments. Most of them are related to changes you have applied to files that shouldn't be there. You might be able to revert all of them by running npm run fix:format locally.

A few more comments:

  • I understand why you did it that way (we say "libraries, plugins, integrations"), but by applying a search on those items you get a selection of items that not always fits the description. This is OK for now, but we need to think about addressing that differently. I will think about that
  • The links at the bottom of an item are off, can you take a look that they are in line with the rest of the element?
  • If I make the screen size smaller the elements become very thin, I think it should switch to 1 item per row with an earlier width-selector

content/en/ecosystem/registry/_index.md Outdated Show resolved Hide resolved
layouts/partials/ecosystem/registry/entry.html Outdated Show resolved Hide resolved
layouts/shortcodes/ecosystem/registry/search-form.html Outdated Show resolved Hide resolved
layouts/shortcodes/ecosystem/registry/search-form.html Outdated Show resolved Hide resolved
@Beccamak
Copy link
Contributor Author

@svrnm I trust you're doing fine. Happy weekend.

I have made the changes you requested. I noticed some of those cards weren't displaying the quick install code so I worked on it. Also, would you advise that all the cards being displayed have a "quick install" to ensure all components are aligned together?

This is also a gentle reminder for the suggestion regarding the "search that returns items that do not always fit the description".

@svrnm svrnm added the outreachy Issues for Outreachy Participants label Oct 14, 2024
@svrnm svrnm changed the title [outreachy] Registry: Put items into sections ✅ [outreachy] Registry: Put items into sections Oct 14, 2024
@svrnm
Copy link
Member

svrnm commented Oct 14, 2024

Thank you @Beccamak! This looks really good, I consider this as done!

The changes required for making this work with the current solution is out of scope for your work. When the application phase for outreachy is over, we can revisit this and talk about making this work, if you want to, but since we do not merge PRs until the end of the application phase, let's keep it as is.

Note, that if you want to get the files, linter CI issues resolved run npm run fix:all locally and push the applied changes.

@Beccamak
Copy link
Contributor Author

@svrnm Thank you so much. This is well noted and understood. I've learned a lot by just trying to implement some of those things. I'll move on to selecting an optional task now. 
Thank you so much for your time.

@svrnm svrnm changed the title ✅ [outreachy] Registry: Put items into sections Put items into sections Nov 22, 2024
@svrnm
Copy link
Member

svrnm commented Nov 22, 2024

While I still like the idea of this PR, I am yet unsure how to incorporate it. The categories "Libraries, Plugins, Integrations" do not work, since they do not match any of the categories we have as of today, but we could do "Instrumentation Libraries, "Collector Components", "Application Integrations" and a few other ones more fitting. This would also allow us to add some words and explaining them better.

This will be some extra work, are you still interested in helping with that @Beccamak ?

cc @open-telemetry/docs-approvers WDYT?

@svrnm svrnm added ux registry and removed outreachy Issues for Outreachy Participants labels Nov 22, 2024
@Beccamak
Copy link
Contributor Author

@svrnm Yes, I'm still interested in helping out.

@svrnm
Copy link
Member

svrnm commented Dec 4, 2024

A few thoughts on that:

  1. we should feature Instrumentation Library, Collector Components and maybe Utilities. Each one of them should also have a small top paragraph letting the end user know what will get from them, what they are etc (I can help with that)
  2. the items for section should be minimal, such that it is visible to a user that there are multiple sections. maybe only the name, the description and a "more" link that can expand the details?

@Beccamak
Copy link
Contributor Author

@svrnm Looking at the first suggestion, we want to have a small top paragraph for Instrumentation Library, Collector Components and Utilities letting the end user know what they will get from them, what they are etc... right?

So that would come before the search bar?

@svrnm
Copy link
Member

svrnm commented Dec 11, 2024

So that would come before the search bar?

Below the Search bar, it would look like this:

SEARCHBAR

Title 1

Description 1

Example of 1 | Example of 1 | Example of 1

(show more)

Title 2

Description 2

Example of 2 | Example of 2 | Eample of 2

(show more)

...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants