Skip to content

Commit 797572e

Browse files
committed
Rewrite the guide to remove "we"
1 parent f4326ab commit 797572e

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

resources/tiers.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,36 @@
22

33
The objective of Meilisearch's Integrations Team is to **ease Meilisearch usage to as many developers as possible**.
44

5-
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.
5+
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 features from 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.
66

7-
The ultimate goal of introducing tiers is to allow the team to have more time to invest in new projects/integrations to impact more users.
7+
The ultimate goal of introducing tiers is to allow the team to have more time to invest in new projects/integrations to impact even more users.
88

9-
To measure the impact of an SDK, the data came from different places like [telemetry](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html) and GitHub's stars, forks, and watchers.
9+
To measure the impact of an SDK, the data come from different places like [telemetry](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html) and GitHub's stars, forks, and watchers.
1010

11-
It is worth remembering that this priority is just a concept introduced by the team that aims to give a decision weight before investing time in some issues of the SDKs. So it does not mean we will never work on feature requests from the bottom tiers anymore, but it says we will prioritize the top tiers most of the time transparently.
11+
It is worth remembering that this priority is just a concept introduced by the team that aims to give a **decision weight** before investing time in some issues of the SDKs. So it does not mean they will never work on feature requests from the bottom tiers anymore, but it says they will prioritize the top tiers most of the time transparently.
1212

13-
:warning: The team will still keeping all officially maintained SDKs **working**. :warning:
13+
:warning: The team will still keep all officially maintained SDKs **working**. :warning:
1414

1515
## Tier #1
1616

17-
The SDKs in group #1 have total priority over the team's time. For example, issues are visited before issues are present in tier #2.
18-
It is worth remembering that this does not mean open issues are addressed and fixed promptly. Every issue needs time to be understood/confirmed/worked on, and consequently closed.
17+
The SDKs in group #1 have absolute priority over the team's time. For example, issues are visited before issues are present in tier #2.
18+
It is worth remembering that this does not mean open issues are addressed and fixed promptly. Every issue needs time to be understood/confirmed/worked on and consequently closed.
19+
1920
All new Meilisearch features that make sense for those SDKs will be available on the release day.
2021

2122
## Tier #2
2223

23-
Tier #2 SDKs are the emergent ones, we strongly believe they can move further, and we are betting on them.
24-
In any case, since they bring less value compared to tier #1 we only spend the amount of time required to keep it working and just do essential maintenance code and code cleanup.
25-
26-
Only in urgent cases where, for example, the SDK is no longer working, issues from the SDKs in group #2 are prioritized over tier #1.
24+
Tier #2 SDKs are the emergent ones. The Integrations Team believes they can move further and are betting on them.
25+
In any case, since they bring less value than tier #1, the team will only spend the time required to keep these SDKs working and do the necessary maintenance code and code cleanup.
2726

27+
Only in urgent cases where, for example, the SDK is no longer working issues from the SDKs in group #2 prioritized over Tier #1.
2828

2929
## Tier #3
3030

3131
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.
3232
As with tier #2, SDKs in this group are prioritized only in critical cases, and they are not going to receive active improvements or maintance from the integrations team.
3333

34-
This is a very special group because we really need help from the community here.
34+
This is a very special group because the Integrations Team really need help from the community here.
3535

3636

3737
## Tiers list
@@ -60,9 +60,9 @@ Gatsby | #3 |
6060
## FAQ
6161
### How are the tiers organized?
6262

63-
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.
63+
The method used is mainly manual and subjective, using previously collected data from the [telemetry](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html) and Github to generate the groups.
6464

65-
To begin we only have 3 tiers, in the future, this number may change.
65+
Only 3 tiers were defined, but this number may change in the future, and this guide will be updated accordindgly.
6666

6767
### Is it possible for an SDK to move up a level?
6868

@@ -81,4 +81,9 @@ It is possible by accessing the README.md of each repository. A tier badge is pr
8181

8282
#### Why SDKs are present in a particular tier?
8383

84-
Because those SDKs have the most active users. Not only from users using the Meilisearch Cloud. They have a larger community in general. Other principles could be used to move SDKs around if we think it is relevant.
84+
In general, because those SDKs have more and the most active users. By "active users," it means more activity in the repository, like contributions, watching (GitHub watchers), stargazers (GitHub stars), and forks (GitHub clones).
85+
86+
Besides GitHub data, we track the importance of integration by constantly watching the data sent through the [telemetry](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html). Note that data is ANONYMOUS, but we know the used client by looking at the `User-Agent`/`X-Meilisearch-Client` headers.
87+
We also give more weight when we know a particular SDK has more Meilisearch Cloud customers.
88+
89+
PS: Other principles that are not written here may be used to move SDKs around if the team thinks it is relevant.

0 commit comments

Comments
 (0)