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

Opt-out settings v2 #5163

Open
8 tasks
curquiza opened this issue Dec 14, 2024 · 0 comments
Open
8 tasks

Opt-out settings v2 #5163

curquiza opened this issue Dec 14, 2024 · 0 comments
Labels
enhancement New feature or improvement impacts cloud This issue involves changes for the Meilisearch's cloud team impacts docs This issue involves changes in the Meilisearch's documentation impacts integrations This issue involves changes in the Meilisearch's integrations
Milestone

Comments

@curquiza
Copy link
Member

Motivation

Let the user customize their relevancy to improve their indexing speed

Usage

https://meilisearch.notion.site/Opt-out-settings-v2-usage-15c4b06b651f8188ae57fca7aa73b527?pvs=4

TODO

Reminders when modifying the Setting API

  • Ensure the new setting route is at least tested by the test_setting_routes macro
  • Ensure Analytics are fully implemented
  • Ensure the dump serializing is consistent with the /settings route serializing, e.g., enums case can be different (camelCase in route and PascalCase in the dump)

Special cases when adding a setting for an experimental feature

  • ⚠️ API stability: The setting does not appear on the main settings route when the feature has never been enabled (e.g. mark it Unset when returned from the index in this situation. See an example)
  • The setting cannot be set when the feature is disabled, either by the main settings route or the subroute (see validate_settings function)
  • If possible, the setting is reset when the feature is disabled (hard if it requires reindexing)

Impacted teams

@meilisearch/docs-team @meilisearch/integration-team @meilisearch/cloud-team

@curquiza curquiza added impacts docs This issue involves changes in the Meilisearch's documentation impacts integrations This issue involves changes in the Meilisearch's integrations impacts cloud This issue involves changes for the Meilisearch's cloud team labels Dec 14, 2024
@curquiza curquiza added this to the v1.13.0 milestone Dec 14, 2024
@curquiza curquiza added the enhancement New feature or improvement label Dec 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or improvement impacts cloud This issue involves changes for the Meilisearch's cloud team impacts docs This issue involves changes in the Meilisearch's documentation impacts integrations This issue involves changes in the Meilisearch's integrations
Projects
None yet
Development

No branches or pull requests

1 participant