You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
403: Changes related to the rebranding r=alallema a=meili-bot
_This PR is auto-generated._
- [X] Change the name `MeiliSearch` to `Meilisearch` in README and CONTRIBUTING.
- [x] ⚠️ Ensure the bot did not update part you don’t want it to update, especially in the code examples in the Getting started.
- [x] Please, ensure there is no other "MeiliSearch". For example, in the comments or in the tests name.
- [x] Put the new logo on the README if needed.
Co-authored-by: meili-bot <[email protected]>
Co-authored-by: alallema <[email protected]>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing <!-- omit in toc -->
2
2
3
-
First of all, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to know in order to contribute to MeiliSearch and its different integrations.
3
+
First of all, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to know in order to contribute to Meilisearch and its different integrations.
4
4
5
5
-[Assumptions](#assumptions)
6
6
-[How to Contribute](#how-to-contribute)
@@ -11,8 +11,8 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
11
11
## Assumptions
12
12
13
13
1.**You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.**
14
-
2.**You've read the MeiliSearch[documentation](https://docs.meilisearch.com) and the [README](/README.md).**
15
-
3.**You know about the [MeiliSearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
14
+
2.**You've read the Meilisearch[documentation](https://docs.meilisearch.com) and the [README](/README.md).**
15
+
3.**You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
16
16
17
17
## How to Contribute
18
18
@@ -38,8 +38,8 @@ Each PR should pass the tests, mypy type checking, and the linter to be accepted
38
38
39
39
```bash
40
40
# Tests
41
-
curl -L https://install.meilisearch.com | sh # download MeiliSearch
42
-
./meilisearch --master-key=masterKey --no-analytics=true # run MeiliSearch
41
+
curl -L https://install.meilisearch.com | sh # download Meilisearch
42
+
./meilisearch --master-key=masterKey --no-analytics=true # run Meilisearch
43
43
pipenv run pytest meilisearch
44
44
# MyPy
45
45
pipenv run mypy meilisearch
@@ -50,7 +50,7 @@ pipenv run pylint meilisearch
50
50
Optionally tox can be used to run test on all supported version of Python, mypy, and linting.
51
51
52
52
```bash
53
-
docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
53
+
docker pull getmeili/meilisearch:latest # Fetch the latest version of Meilisearch image from Docker Hub
54
54
docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
55
55
pipenv run tox
56
56
```
@@ -98,7 +98,7 @@ Some notes on GitHub PRs:
98
98
99
99
## Release Process (for internal team only)
100
100
101
-
MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/).
101
+
Meilisearch tools follow the [Semantic Versioning Convention](https://semver.org/).
102
102
103
103
### Automation to Rebase and Merge the PRs <!-- omit in toc -->
<palign="center">⚡ The MeiliSearch API client written for Python 🐍</p>
23
+
<palign="center">⚡ The Meilisearch API client written for Python 🐍</p>
24
24
25
-
**MeiliSearch Python** is the MeiliSearch API client for Python developers.
25
+
**Meilisearch Python** is the Meilisearch API client for Python developers.
26
26
27
-
**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)
27
+
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
28
28
29
29
## Table of Contents <!-- omit in toc -->
30
30
31
31
-[📖 Documentation](#-documentation)
32
32
-[🔧 Installation](#-installation)
33
33
-[🚀 Getting Started](#-getting-started)
34
-
-[🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
34
+
-[🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
35
35
-[💡 Learn More](#-learn-more)
36
36
-[⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
37
37
@@ -49,21 +49,21 @@ With `pip3` in command line:
49
49
pip3 install meilisearch
50
50
```
51
51
52
-
### Run MeiliSearch<!-- omit in toc -->
52
+
### Run Meilisearch<!-- omit in toc -->
53
53
54
-
There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
54
+
There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
55
55
56
56
For example, using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
57
57
58
58
```bash
59
-
# Install MeiliSearch
59
+
# Install Meilisearch
60
60
curl -L https://install.meilisearch.com | sh
61
61
62
-
# Launch MeiliSearch
62
+
# Launch Meilisearch
63
63
./meilisearch --master-key=masterKey
64
64
```
65
65
66
-
NB: you can also download MeiliSearch from **Homebrew** or **APT** or even run it using **Docker**.
66
+
NB: you can also download Meilisearch from **Homebrew** or **APT** or even run it using **Docker**.
Note that MeiliSearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task).
168
+
Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task).
169
169
170
170
Then, you can perform the search:
171
171
@@ -195,9 +195,9 @@ index.search(
195
195
}
196
196
```
197
197
198
-
## 🤖 Compatibility with MeiliSearch
198
+
## 🤖 Compatibility with Meilisearch
199
199
200
-
This package only guarantees the compatibility with the [version v0.25.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0).
200
+
This package only guarantees the compatibility with the [version v0.25.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.0).
201
201
202
202
## 💡 Learn More
203
203
@@ -216,4 +216,4 @@ If you want to know more about the development workflow or want to contribute, p
216
216
217
217
<hr>
218
218
219
-
**MeiliSearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
219
+
**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
0 commit comments