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

Expose more service metadata #124

Closed
1 task done
savetheclocktower opened this issue Dec 26, 2023 · 2 comments · Fixed by #125
Closed
1 task done

Expose more service metadata #124

savetheclocktower opened this issue Dec 26, 2023 · 2 comments · Fixed by #125
Labels
enhancement New feature or request

Comments

@savetheclocktower
Copy link
Contributor

savetheclocktower commented Dec 26, 2023

Have you checked for existing feature requests?

  • Completed

Summary

One thing we should do to improve the “IDE story” is to surface the concept of services to users.

What we seem not to want to do: “Here is a monolithic package that installs a bunch of stuff you don't understand.”

What we should probably do instead: “The ide-typescript package provides these services; let's help you find packages to consume them.”

Two obvious improvements:

Tell users when they're searching for service consumers/providers

The service and serviceType search params are useful, but a search results page that uses those params doesn't have anything on the page to distinguish it from an ordinary package listing. Here's how we could fix that:

Screen Shot 2023-12-26 at 3 41 46 PM

(Through working on this, I discovered pagination counts are wrong; filed this issue.)

Tell users when a package consumes/provides services

On a package detail page, we can enumerate the services provided and consumed. For instance, if a package provides the foo service, foo would be a link to a search results page that filters on packages that consume foo.

A couple ways we could present this:

Screen Shot 2023-12-26 at 3 09 07 PM Screen Shot 2023-12-26 at 3 08 44 PM

What benefits does this feature provide?

Explained above.

Any alternatives?

No, I think this is the best option. We want to be able to tell users “here's how you can do X” without privileging one particular package over others. “Here are all packages that can do X” is a good way of doing that. The user can make judgments based on download counts, on the presence of “Made for Pulsar!” badges, or whatever else.

Other examples:

No response

@savetheclocktower savetheclocktower added the enhancement New feature or request label Dec 26, 2023
@confused-Techie
Copy link
Member

@savetheclocktower Thanks for contributing over on this repo!

Overall, this is a fantastic suggestion, and I really like the way your made the mockup for the sidebar here, which I honestly think should be the way we go about adding this new information.

Plus, it'd be a great idea to expose the ability for users to actually search for these parameters, although the search on the website is still lacking, so maybe that isn't the highest priority.

If you have the mockup HTML to share that'd be rad, otherwise I'll take a look at implementing this sidebar, unless anyone beats me too it, thanks!

@savetheclocktower
Copy link
Contributor Author

I'll open the PR today.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants