Skip to content

Improve coherence between dataset and examples #860

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

Closed
CaroFG opened this issue Mar 11, 2021 · 4 comments · Fixed by #2061
Closed

Improve coherence between dataset and examples #860

CaroFG opened this issue Mar 11, 2021 · 4 comments · Fixed by #2061

Comments

@CaroFG
Copy link
Contributor

CaroFG commented Mar 11, 2021

Currently, the documentation provides examples that mention fields not present in the dataset available for download, like director or rating.

You can see it one the faceted search section: https://docs.meilisearch.com/reference/features/faceted_search.html#setting-up-facets or in the filtering one: https://docs.meilisearch.com/reference/features/filtering.html#examples

We could either add those fields to the dataset or replace the examples.

@dichotommy
Copy link
Contributor

Related to meilisearch/devrel#134

@guimachiavelli
Copy link
Member

Adding to the list of examples that must be fixed: /reference/features/search_parameters.md

Some of the examples will be fixed by #1016, but I am sure that at least one of them still refers to the director field.

@bidoubiwa
Copy link
Contributor

Some problems with this proposition:

  • Some examples do not fit well with the dataset. And thus do not serve well the explanation
  • Adding more fields to the dataset will make the dataset bigger, in term of size. We want to avoid asking the user to download a to big dataset

@guimachiavelli
Copy link
Member

guimachiavelli commented Jun 29, 2021

Adding more fields to the dataset will make the dataset bigger, in term of size. We want to avoid asking the user to download a to big dataset

I missed the suggestion regarding expanding the dataset. I agree we should not add fields — if anything, I'd prefer movies.json to be smaller.

Perhaps we should only reference specific datasets in guides and tutorials (e.g. quick start, how-to articles, etc) and dissociate our examples from the movies.json dataset in things like the API reference?

This would mean moving examples away from movies and use different types of examples to imply we are not assuming users to be familiar with movies.json

@maryamsulemani97 maryamsulemani97 linked a pull request Feb 2, 2023 that will close this issue
bors bot added a commit that referenced this issue Feb 16, 2023
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
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
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants