Skip to content

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

Merged
merged 6 commits into from
Mar 1, 2023
Merged

Introduce tiers.md #242

merged 6 commits into from
Mar 1, 2023

Conversation

brunoocasali
Copy link
Member

@brunoocasali brunoocasali commented Feb 14, 2023

This is the first version of the tiers concept we are introducing to our processes.

I will provide the details about how the list was made and share it in future iterations (if possible - since it can contain sensitive data).

Copy link
Contributor

@alallema alallema left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really well explain thank @brunoocasali 🥐

docs-searchbar.js | #3 |
Firebase | #3 |
Dart | #3 |
Java | #3 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why Java is only on tier #3?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you indeed should keep an eye on Java usage, because the community is huge and already came to a lot of time (they are currently a little bit frustrated because our SDK is not up to date). Can quickly become tier #2 or (even tier #1 😱)

Copy link
Member Author

Choose a reason for hiding this comment

The 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 #3. I'll share what is my rationale behind the list and the order after merging this first version :)

alallema
alallema previously approved these changes Feb 15, 2023
bidoubiwa
bidoubiwa previously approved these changes Feb 15, 2023
Copy link
Contributor

@bidoubiwa bidoubiwa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🔥

@brunoocasali brunoocasali dismissed stale reviews from bidoubiwa and alallema via 797572e February 27, 2023 17:11
@brunoocasali brunoocasali added the documentation Improvements or additions to documentation label Feb 27, 2023
.NET | #2 |
Rust | #2 |
Symfony | #3 |
docs-searchbar.js | #3 |
Copy link
Member

@gmourier gmourier Feb 28, 2023

Choose a reason for hiding this comment

The 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.

Copy link
Member Author

Choose a reason for hiding this comment

The 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!


### How to identify which tier an SDK belongs to?

It is possible by accessing the README.md of each repository. A tier badge is present below the Meilisearch logo. The badge can have the following values: "tiers #1", "tiers #2" and "tiers #3". For example:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not convinced that adding the badges is a good idea. SDK's will still work with the latest versions of Meilisearch and most users will be satisfied with its current state.

By warning them that this is a low priority SDK it might result in:

  • User fearing deprecation
  • User complaining because they don't want their SDK in that tier list even if they would never user the missing features
  • Give the impression that we are going backward in activity like a "cut in budget"

If something is missing, an issue exist in any case with the missing feature which reassure the user that we did not forget about the SDK, provide them a place to tell us they need it, and help them implement it if they want it sooner than later.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to give up of the badges 😢. But I have to agree with you on that.

brunoocasali and others added 2 commits February 28, 2023 10:24
Co-authored-by: Guillaume Mourier <[email protected]>
Co-authored-by: Guillaume Mourier <[email protected]>
curquiza
curquiza previously approved these changes Feb 28, 2023
alallema
alallema previously approved these changes Mar 1, 2023
@bidoubiwa
Copy link
Contributor

Before approving this, I would love to come to a conclusion about the possible badges and communication around the tiers.

I don't know if by

I don't want to give up of the badges 😢. But I have to agree with you on that.

You meant we keep them anyway, or if you open the possibility to talk about it?

From my point of view, if I use a tool and the maintainers communicate about the fact that they are not going to be as focussed on that tool as before, I lose trust in the tool and change it ASAP to something more actively maintained.

@brunoocasali brunoocasali dismissed stale reviews from alallema and curquiza via 0173b87 March 1, 2023 16:36
@brunoocasali
Copy link
Member Author

Before approving this, I would love to come to a conclusion about the possible badges and communication around the tiers.

I don't know if by

I don't want to give up of the badges 😢. But I have to agree with you on that.

You meant we keep them anyway, or if you open the possibility to talk about it?

From my point of view, if I use a tool and the maintainers communicate about the fact that they are not going to be as focussed on that tool as before, I lose trust in the tool and change it ASAP to something more actively maintained.

After discussing it privately, I agreed to remove the badge system, it will bring more cons than pro's at this time, so the idea is to add it later if needed :)

Copy link
Contributor

@bidoubiwa bidoubiwa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🔥

@brunoocasali brunoocasali merged commit 43ae43c into main Mar 1, 2023
@brunoocasali brunoocasali deleted the tiers branch March 1, 2023 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants