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

Registry metadata: do we need keywords? #197

Open
peterhuene opened this issue Sep 5, 2023 · 3 comments
Open

Registry metadata: do we need keywords? #197

peterhuene opened this issue Sep 5, 2023 · 3 comments

Comments

@peterhuene
Copy link
Member

Following a discussion on a cargo-component PR, cargo-component is implementing support for mapping Cargo.toml fields to the appropriate registry metadata.

Currently cargo supports distinct categories and keywords fields, where the former supports a list of predefined slugs meant to describe the overall category for the package and the latter meant to describe keywords about the package itself.

Right now the registry metadata supports only categories, with what I believe is the intention to be the set of keywords meant for searching the package.

Should this field in the registry metadata be called keywords instead? Should we have two distinct fields like cargo?

cc @silesmo.

@silesmo
Copy link
Member

silesmo commented Sep 5, 2023

I brought this up in the initial discussion in one of the meetings. We landed on just a list of categories as we didn't want to restrict the possible options by having a moderated list of slugs. The reason for that we wanted to leave the meaning of the categories and what categories would be supported up to the registry implementation and different implementation having the ability to offer support different categories and just ignore what the implementation wouldn't support.

@peterhuene
Copy link
Member Author

Regarding "categories", that makes total sense to me.

I think, though, that "keywords" speak more to the notion of "this is what people might search for to find this package".

Should we also have a keywords field in the registry metadata?

If not, should I be populating the categories in the registry metadata with the union of categories and keywords from Cargo.toml?

@silesmo
Copy link
Member

silesmo commented Sep 13, 2023

I'm a bit unsure to be honest I originally assumed this would be covered by categories and then each registry could implement free form search against information in the description. But I guess adding keywords could make sense as well. I'm fine with adding keywords if you prefer that?

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

No branches or pull requests

2 participants