-
Notifications
You must be signed in to change notification settings - Fork 14
Introduce tiers.md #242
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
Introduce tiers.md #242
Changes from 1 commit
f3d76b3
f4326ab
797572e
d88a289
f85b912
0173b87
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| # SDK tiers | ||
|
|
||
| The objective of Meilisearch's Integrations Team is to **ease Meilisearch usage to as many developers as possible**. | ||
|
|
||
| Given this statement, **tiers** are nothing more than a __group of SDKs/integrations__ where the integrations team can fairly divide their attention. Unfortunately is not possible to keep all the SDKs 100% updated against the new Meilisearch releases all the time, the Integrations Team is a polyglot small team that maintains 30+ different integrations and tools, so it is humanly impossible to consistently meet the Meilisearch quality standards. | ||
|
|
||
| The ultimate goal of introducing tiers is to allow the team to have more time for new projects/integrations so that more time can be invested and more users will be impacted. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| It's been using [data collected here](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html) and data like GitHub stars, forks, and watchers to measure the impact of an SDK. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| It is worth remembering that this priority is just a concept introduced by the team where it aims to give a decision weight before | ||
| we invest time in some issues of some SDK in question. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| :warning: We will keep all officially maintained SDKs **working**. :warning: | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Tier #1 | ||
|
|
||
| The SDKs in group #1 have total priority over the team's time. Issues are visited before issues are present in tier #2, for example. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| It is worth remembering that this does not mean open issues will be finalized promptly. Every issue needs time to be understood/confirmed/worked on, and consequently closed. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| All new Meilisearch features that make sense for those SDKs will be available in the release day. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Tier #2 | ||
|
|
||
| Tier #2 SDKs are the emergent ones, we strongly believe they can move further, and we are betting on them. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| In any case, since they do not bring that much value compared to tier #1 we will only apply the amount of time required to keep it working and do important maintenance code and code cleanup. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Only in urgent cases where, for example, the SDK is no longer working issues from the SDKs in group #2 will be prioritized in comparison to tier #1. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ## Tier #3 | ||
|
|
||
| The SDKs in group #3 have relatively low user adoption compared to groups #2 and #1. They are probably new or have a small community behind the tech stack in the first place. | ||
| As with tier #2 SDKs in this group will be prioritized only in critical cases, and they are not going to receive active improvements from the integrations team. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| This is a very special group because we really need help from the community here. | ||
|
|
||
|
|
||
| ## Tiers list | ||
|
|
||
| Integration | Tier | | ||
| -------------|------| | ||
| Javascript | #1 | | ||
| PHP | #1 | | ||
| Instant Meilisearch | #1 | | ||
| Python | #1 | | ||
| Go | #1 | | ||
| Strapi | #2 | | ||
| Ruby | #2 | | ||
| Rails | #2 | | ||
| .NET | #2 | | ||
| Rust | #2 | | ||
| Symfony | #3 | | ||
| docs-searchbar.js | #3 | | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is there a reason not to have doc-scrapper in the list? That's potentially something we will want to maintain / replace actively at some point because It's an excellent opener to get many projects moving from Algolia (but not only) to Meilisearch for their documentation.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not really. It is just because we don't have the User Agent there! |
||
| Firebase | #3 | | ||
| Dart | #3 | | ||
| Java | #3 | | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why Java is only on tier #3?
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I hope they will! But for now, since we don't have data coming from the Java users, Java is |
||
| Swift | #3 | | ||
| Vuepress | #3 | | ||
| Gatsby | #3 | | ||
|
|
||
| ## FAQ | ||
| ### How will the tiers be organized? | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| The method used is mostly manual and subjective, where we use the data previously collected from the [telemetry](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html) and Github to generate groups. | ||
|
|
||
| At first there are only 3 tiers, and in the future this number may change. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Is it possible for an SDK to be moved up a level? | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Yes, fully possible! Especially if the team detects that more users are interested and definitely using it. | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Whenever a anomaly is detected, a change can be submitted to the `integration-guides` and the groups will be modified to better manage the team's time. The reassessment of the tiers will be carried out every release cycle (8 weeks). | ||
bidoubiwa marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### How to identify that an SDK belongs to some level? | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| It is possible by accessing the README.md of each repository, and it will contain a tier badge | ||
| below the Meilisearch logo, this badge says: "tiers #1", "tiers #2" and "tiers #3" like this: | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| [](https://github.com/meilisearch/integration-guides/blob/main/resources/tiers.md) | ||
| [](https://github.com/meilisearch/integration-guides/blob/main/resources/tiers.md) | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| [](https://github.com/meilisearch/integration-guides/blob/main/resources/tiers.md) | ||
brunoocasali marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| #### Why SDKs are present in a particular tier? | ||
|
|
||
| Because those SDKs have the most active users whether in the Meilisearch Cloud or not. Also they have a larger or broader community in general. Other principles could be used to move SDKs around if we think is the right thing to do. | ||
bidoubiwa marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Uh oh!
There was an error while loading. Please reload this page.