✅ [outreachy] Registry: Put items into sections

[Beccamak]

#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.

[linux-foundation-easycla[bot]]

The committers listed above are authorized under a signed CLA.

• :white_check_mark: login: Beccamak / name: Rebecca (35a4806a3e2906a20ad2756360b4a640105f0025, 9901c8d4b92e7647426f1d5d1049405e452d588a, 5d4332186516af3af09125e3bc4a66c6fa1707e6, 997d3c550e9c79dadcfda2f9a6a2c74c821d9522, 54d0be003e5ee315c27b8b6d9243203ab45697ad, 7bab46d577bfd3a0238be14df91867477978bf6f)

[Beccamak]

@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]

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]

@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]

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?

[Beccamak]

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

[svrnm]

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]

@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]

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)

...

[svrnm]

@Beccamak any thoughts on my previous comment?

[theletterf]

Closing due to lack of activity.