Skip to content

Commit 8a70ae2

Browse files
bors[bot]meili-botalallema
authored
Merge #403
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]>
2 parents 87278e2 + 7f3e8af commit 8a70ae2

16 files changed

+144
-144
lines changed

.code-samples.meilisearch.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# This code-samples file is used by the MeiliSearch documentation
1+
# This code-samples file is used by the Meilisearch documentation
22
# Every example written here will be automatically fetched by
33
# the documentation on build
44
# You can read more on https://github.com/meilisearch/documentation/tree/master/.vuepress/code-samples

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ If applicable, add screenshots or logs to help explain your problem.
2222

2323
**Environment (please complete the following information):**
2424
- OS: [e.g. Debian GNU/Linux]
25-
- MeiliSearch version: [e.g. v.0.20.0]
25+
- Meilisearch version: [e.g. v.0.20.0]
2626
- meilisearch-python version: [e.g v0.14.1]

.github/workflows/pre-release-tests.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Testing the code base against the MeiliSearch pre-releases
1+
# Testing the code base against the Meilisearch pre-releases
22
name: Pre-Release Tests
33

44
# Will only run for PRs and pushes to bump-meilisearch-v*
@@ -26,9 +26,9 @@ jobs:
2626
uses: dschep/install-pipenv-action@v1
2727
- name: Install dependencies
2828
run: pipenv install --dev
29-
- name: Get the latest MeiliSearch RC
29+
- name: Get the latest Meilisearch RC
3030
run: echo "MEILISEARCH_VERSION=$(curl https://raw.githubusercontent.com/meilisearch/integration-guides/main/scripts/get-latest-meilisearch-rc.sh | bash)" >> $GITHUB_ENV
31-
- name: MeiliSearch (${{ env.MEILISEARCH_VERSION }}) setup with Docker
31+
- name: Meilisearch (${{ env.MEILISEARCH_VERSION }}) setup with Docker
3232
run: docker run -d -p 7700:7700 getmeili/meilisearch:${{ env.MEILISEARCH_VERSION }} ./meilisearch --master-key=masterKey --no-analytics=true
3333
- name: Test with pytest
3434
run: pipenv run pytest

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
uses: dschep/install-pipenv-action@v1
3131
- name: Install dependencies
3232
run: pipenv install --dev
33-
- name: MeiliSearch (latest version) setup with Docker
33+
- name: Meilisearch (latest version) setup with Docker
3434
run: docker run -d -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --no-analytics=true --master-key=masterKey
3535
- name: Test with pytest
3636
run: pipenv run pytest

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing <!-- omit in toc -->
22

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

55
- [Assumptions](#assumptions)
66
- [How to Contribute](#how-to-contribute)
@@ -11,8 +11,8 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
1111
## Assumptions
1212

1313
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.**
1616

1717
## How to Contribute
1818

@@ -38,8 +38,8 @@ Each PR should pass the tests, mypy type checking, and the linter to be accepted
3838

3939
```bash
4040
# 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
4343
pipenv run pytest meilisearch
4444
# MyPy
4545
pipenv run mypy meilisearch
@@ -50,7 +50,7 @@ pipenv run pylint meilisearch
5050
Optionally tox can be used to run test on all supported version of Python, mypy, and linting.
5151

5252
```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
5454
docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
5555
pipenv run tox
5656
```
@@ -98,7 +98,7 @@ Some notes on GitHub PRs:
9898

9999
## Release Process (for internal team only)
100100

101-
MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/).
101+
Meilisearch tools follow the [Semantic Versioning Convention](https://semver.org/).
102102

103103
### Automation to Rebase and Merge the PRs <!-- omit in toc -->
104104

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<p align="center">
2-
<img src="https://res.cloudinary.com/meilisearch/image/upload/v1587402338/SDKs/meilisearch_python.svg" alt="MeiliSearch-Python" width="200" height="200" />
2+
<img src="https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_python.svg" alt="Meilisearch-Python" width="200" height="200" />
33
</p>
44

5-
<h1 align="center">MeiliSearch Python</h1>
5+
<h1 align="center">Meilisearch Python</h1>
66

77
<h4 align="center">
8-
<a href="https://github.com/meilisearch/MeiliSearch">MeiliSearch</a> |
8+
<a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
99
<a href="https://docs.meilisearch.com">Documentation</a> |
1010
<a href="https://slack.meilisearch.com">Slack</a> |
1111
<a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
@@ -20,18 +20,18 @@
2020
<a href="https://app.bors.tech/repositories/28782"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
2121
</p>
2222

23-
<p align="center">⚡ The MeiliSearch API client written for Python 🐍</p>
23+
<p align="center">⚡ The Meilisearch API client written for Python 🐍</p>
2424

25-
**MeiliSearch Python** is the MeiliSearch API client for Python developers.
25+
**Meilisearch Python** is the Meilisearch API client for Python developers.
2626

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)
2828

2929
## Table of Contents <!-- omit in toc -->
3030

3131
- [📖 Documentation](#-documentation)
3232
- [🔧 Installation](#-installation)
3333
- [🚀 Getting Started](#-getting-started)
34-
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
34+
- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
3535
- [💡 Learn More](#-learn-more)
3636
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
3737

@@ -49,21 +49,21 @@ With `pip3` in command line:
4949
pip3 install meilisearch
5050
```
5151

52-
### Run MeiliSearch <!-- omit in toc -->
52+
### Run Meilisearch <!-- omit in toc -->
5353

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).
5555

5656
For example, using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
5757

5858
```bash
59-
# Install MeiliSearch
59+
# Install Meilisearch
6060
curl -L https://install.meilisearch.com | sh
6161

62-
# Launch MeiliSearch
62+
# Launch Meilisearch
6363
./meilisearch --master-key=masterKey
6464
```
6565

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**.
6767

6868
## 🚀 Getting Started
6969

@@ -86,7 +86,7 @@ documents = [
8686
{ 'id': 6, 'title': 'Philadelphia', 'genres': ['Drama'] },
8787
]
8888

89-
# If the index 'movies' does not exist, MeiliSearch creates it when you first add the documents.
89+
# If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
9090
index.add_documents(documents) # => { "uid": 0 }
9191
```
9292

@@ -95,7 +95,7 @@ With the task `uid`, you can check the status (`enqueued`, `processing`, `succee
9595
#### Basic Search <!-- omit in toc -->
9696

9797
``` python
98-
# MeiliSearch is typo-tolerant:
98+
# Meilisearch is typo-tolerant:
9999
index.search('caorl')
100100
```
101101

@@ -165,7 +165,7 @@ index.update_filterable_attributes([
165165

166166
You only need to perform this operation once.
167167

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).
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).
169169

170170
Then, you can perform the search:
171171

@@ -195,9 +195,9 @@ index.search(
195195
}
196196
```
197197

198-
## 🤖 Compatibility with MeiliSearch
198+
## 🤖 Compatibility with Meilisearch
199199

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).
201201

202202
## 💡 Learn More
203203

@@ -216,4 +216,4 @@ If you want to know more about the development workflow or want to contribute, p
216216

217217
<hr>
218218

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

Comments
 (0)