meilisearch / integration-guides

Central reference for Meilisearch integrations.
https://meilisearch.com
MIT License
137 stars 15 forks source link

Write some guidelines about meilisearch integrations into external repositories #269

Closed brunoocasali closed 1 year ago

brunoocasali commented 1 year ago

I just learned that we had a connection with Airbyte. And in fact, I just heard about it because it is broken.

So, I suggest keeping a paper trail of Meilisearch presence into other tools that may be relevant or not in our internal processes, ex: In the past, we had to deal with some breaking changes on the Laravel Scout side. We did that because Laravel Scout is an important integration for us, but we do not directly maintain it.

So the idea is to keep a list in the integration-guides where we can track all those open-source packages. Plus by doing it we may warn them about new features it could be implemented for example.

The current list of external integrations are:

My question for the @meilisearch/integration-team is, is it worth having such tracking? Or we could just have a section in the awesome-meilisearch and that would be ok?

alallema commented 1 year ago

I am conflicted. I do think it would be good to track them, but for what purpose?

I'm afraid it might take up our time for integrations that we don't own. At the same time, it could be important to verify that everything is working correctly, share improvements effectively with them, ensure at least once that users have a smooth experience when using these integrations, and maintain good contact with the team that manages them.

If we decide to track them, it would be good to do it, for example, at the beginning of each quarter, semester, etc., and possibly distribute the task based on the scope: Airbyte - Python Meduja.js - Js Laravel Scout - PHP

brunoocasali commented 1 year ago

My only concern is to invest time in inactive integrations or abandoned ones. Otherwise, I'm ok with that. It is still our brand in the game. But of course, some situations are not worth it, spend time on it, and that's also good!

Because if we take the Airbyte one, for example. By keeping a working version of our plugin inside Airbyte, we can guarantee users can adopt Meilisearch even easier from whatever data source they may have.

What bugs me is that I, the integrations manager, didn't know its existence!

sanders41 commented 1 year ago

@brunoocasali this is admittedly not the best process, but what I have done is use the used by page (https://github.com/meilisearch/meilisearch-python/network/dependents for example) to find people using my packages and then I will occasionally check their issues for anything I can help with.

I suspect that with the GitHub API there would be a way for you to gather the used by information so you have some visibility into it in an aggregated way. It's not 100% of the users but maybe a start.

brunoocasali commented 1 year ago

That's an excellent idea indeed! Even if they show at least the more relevant packages would be helpful!

brunoocasali commented 1 year ago

Unfortunately, we don't have time to create a new process like this one, even if it is helpful.

If someone from the community spots any issue in an integration like this, please reach us in the discord so we can help!