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

Docs: Search API sort=score #11105

Open
g-saracca opened this issue Dec 17, 2024 · 1 comment
Open

Docs: Search API sort=score #11105

g-saracca opened this issue Dec 17, 2024 · 1 comment
Labels
good first issue appears at https://github.com/IQSS/dataverse/contribute Help Wanted: Documentation Mentor: pdurbin Size: 3 A percentage of a sprint. 2.1 hours. Type: Suggestion an idea

Comments

@g-saracca
Copy link
Contributor

It would be nice if the Search API documentation would mention the extra value for the sort parameter which is score and how the response behaves based on this.

@g-saracca g-saracca added Type: Suggestion an idea Size: 3 A percentage of a sprint. 2.1 hours. labels Dec 17, 2024
@pdurbin
Copy link
Member

pdurbin commented Dec 17, 2024

Some more context from Slack:

Screenshot 2024-12-17 at 11 21 57 AM

Also, here's how "Relevance" looks in the UI after you do a search:

Screenshot 2024-12-17 at 11 22 40 AM

Here's the file to edit: https://github.com/IQSS/dataverse/blob/develop/doc/sphinx-guides/source/api/search.rst

Maybe I'll see if someone from the community would like to work on this. 🤔

Here's how to work on docs: https://guides.dataverse.org/en/6.5/contributor/documentation.html

Zulip thread: https://dataverse.zulipchat.com/#narrow/channel/446770-docs/topic/add.20.22score.22.20to.20Search.20API.20docs/near/489525150

@pdurbin pdurbin added Help Wanted: Documentation Mentor: pdurbin good first issue appears at https://github.com/IQSS/dataverse/contribute labels Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue appears at https://github.com/IQSS/dataverse/contribute Help Wanted: Documentation Mentor: pdurbin Size: 3 A percentage of a sprint. 2.1 hours. Type: Suggestion an idea
Projects
Status: No status
Development

No branches or pull requests

2 participants