Skip to content

Examples, datasets, and movies #1026

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
dichotommy opened this issue Jul 5, 2021 · 0 comments
Closed

Examples, datasets, and movies #1026

dichotommy opened this issue Jul 5, 2021 · 0 comments

Comments

@dichotommy
Copy link
Contributor

dichotommy commented Jul 5, 2021

This issue aims to give an update on the current feelings of the @meilisearch/docs-team surrounding our examples and use of the movies.json dataset.

Discussion summary

  • In the current state of examples on the site, it’s not clear if an example is referring to the actual movies.json dataset or just demonstrating a concept with a theoretical "Movies" index. There have been cases of users getting confused when they test a command on movies.json and find that they get a different response than the one displayed on the docs.
  • One solution would be making all examples on the site consistent with movies.json or any other dataset. While this is achievable, it would have the side effect of limiting our flexibility and bloating example responses with unnecessary fields. Longer examples = less clear examples.
  • A better solution would be to avoid referring to any existing dataset with our examples. That way we will have maximum freedom, nobody will be tempted to test our examples, and we won't be burdened with keeping them up-to-date with dataset changes.
  • How to do this? We could rewrite all of our code samples, examples, and responses to refer to a single imaginary dataset, e.g. tv-shows, or use various hypothetical datasets as we see fit, e.g. shoes, pets, tv-shows.
  • However, we already have example commands and responses written in eight (?) languages about a Movies dataset, so it seems like a waste to throw that away.
  • Instead, we think it would be better to change Quick Start to use a different dataset, then remove movies.json from the docs site.
  • This way we are still able to describe our concepts through Movies, something our users are familiar with, but there is no confusion with a literal dataset. Users who follow the Quick Start and subsequent tutorials will still have the opportunity to work with an actual dataset, but on the rest of the site examples will be purely demonstrative, referring to a theoretical Movies dataset.

Next steps

We have a total rewrite of the Quick Start guide planned for Q4 2021. This would be a nice opportunity to find/create a dataset to replace movies.json and make the switch.

The only limitations (to my knowledge) are that the dataset must be small enough to be a quick download, and should be able to show off all of MeiliSearch's most important features. Since it's a common and intuitive use-case, an eCommerce dataset would be ideal.

@guimachiavelli guimachiavelli linked a pull request Jul 6, 2021 that will close this issue
@guimachiavelli guimachiavelli changed the title examples, datasets, and movies Examples, datasets, and movies Aug 24, 2021
@meilisearch meilisearch locked and limited conversation to collaborators Nov 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant