Skip to content

Improve examples in the filter page #1850

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.

Sign up for GitHub

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

Jump to bottom
Closed
curquiza opened this issue Aug 31, 2022 · 0 comments · Fixed by #2061
Closed

Improve examples in the filter page #1850

curquiza opened this issue Aug 31, 2022 · 0 comments · Fixed by #2061

Comments

@curquiza
Copy link
Member

Not an emergency since we don't have a lot of questions, the one I found is old, but still true

People reading the docs do not always guess how to filter in a range of values. See: meilisearch/meilisearch#2062 (comment)

Maybe it could be better to add an example with a range of values?

For example, to find the price between 0 and 1000, you can filter like this

"filter": "price > 0 AND price < 1000"

What is obvious for us reading the </> operator is not always obvious for everyone.

Again, not an emergency, just a suggestion for improvement in this page.
@guimachiavelli guimachiavelli self-assigned this Sep 1, 2022
@guimachiavelli guimachiavelli mentioned this issue Oct 4, 2022
Closed
@guimachiavelli guimachiavelli removed their assignment Oct 4, 2022
@maryamsulemani97 maryamsulemani97 mentioned this issue Jan 2, 2023
Merged
@maryamsulemani97 maryamsulemani97 linked a pull request Feb 2, 2023 that will close this issue
review filtering guide #2061
Merged
bors bot added a commit that referenced this issue Feb 16, 2023
@bors @maryamsulemani97
Merge #2061
d794d8b 
2061: review filtering guide r=maryamsulemani97 a=maryamsulemani97

closes #1902, #860, #837, and #1850

- moves all operators to a new heading
- removes SQL syntax and combines it with the curl code samples
- replaces amazon and imdb images for facets with meilisearch demo images
- removes unused images in `.vuepress/public/faceted-search`
- remove redundant code samples
<hr>

- Improve coherence between dataset and examples
  - A sample document was added as part of  #2050 with `rating` and `director` fields
  - This PR uses `movie_ratings` instead of `movies` to clarify that this is a separate dataset
     - `faceted_search_facets_1` still  uses `movies` as this code sample is used in the API reference as well

Co-authored-by: Maryam Sulemani <[email protected]>
Co-authored-by: Maryam <[email protected]>
Co-authored-by: maryamsulemani97 <[email protected]>
bors bot added a commit that referenced this issue Feb 16, 2023
@bors @maryamsulemani97
Merge #2061
f7243dc 
2061: review filtering guide r=maryamsulemani97 a=maryamsulemani97

closes #1902, #860, #837, and #1850

- moves all operators to a new heading
- removes SQL syntax and combines it with the curl code samples
- replaces amazon and imdb images for facets with meilisearch demo images
- removes unused images in `.vuepress/public/faceted-search`
- remove redundant code samples
<hr>

- Improve coherence between dataset and examples
  - A sample document was added as part of  #2050 with `rating` and `director` fields
  - This PR uses `movie_ratings` instead of `movies` to clarify that this is a separate dataset
     - `faceted_search_facets_1` still  uses `movies` as this code sample is used in the API reference as well

Co-authored-by: Maryam Sulemani <[email protected]>
Co-authored-by: Maryam <[email protected]>
Co-authored-by: maryamsulemani97 <[email protected]>
@bors bors bot closed this as completed in #2061 Feb 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

review filtering guide meilisearch/documentation
3 participants
@guimachiavelli @curquiza @maryamsulemani97