From c562655be7d2be99769fcfa272b1cfae1337754f Mon Sep 17 00:00:00 2001 From: meili-bot <74670311+meili-bot@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:31:03 +0100 Subject: [PATCH 01/10] Update CONTRIBUTING.md --- CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bef47a651..130f62780 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ # Contributing -First, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to start contributing to MeiliSearch. +First, thank you for contributing to meilisearch! The goal of this document is to provide everything you need to start contributing to meilisearch. -Remember that there are many ways to contribute other than writing code: writing [tutorials or blog posts](https://github.com/meilisearch/awesome-meilisearch), improving [the documentation](https://github.com/meilisearch/documentation), submitting [bug reports](https://github.com/meilisearch/MeiliSearch/issues/new?assignees=&labels=&template=bug_report.md&title=) and [feature requests](https://github.com/meilisearch/product/discussions/categories/feedback-feature-proposal)... +Remember that there are many ways to contribute other than writing code: writing [tutorials or blog posts](https://github.com/meilisearch/awesome-meilisearch), improving [the documentation](https://github.com/meilisearch/documentation), submitting [bug reports](https://github.com/meilisearch/meilisearch/issues/new?assignees=&labels=&template=bug_report.md&title=) and [feature requests](https://github.com/meilisearch/product/discussions/categories/feedback-feature-proposal)... ## Table of Contents - [Assumptions](#assumptions) @@ -13,8 +13,8 @@ Remember that there are many ways to contribute other than writing code: writing ## Assumptions 1. **You're familiar with [Github](https://github.com) and the [Pull Requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.** -2. **You've read the MeiliSearch [documentation](https://docs.meilisearch.com).** -3. **You know about the [MeiliSearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). +2. **You've read the meilisearch [documentation](https://docs.meilisearch.com).** +3. **You know about the [meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.** ## How to Contribute @@ -22,21 +22,21 @@ Remember that there are many ways to contribute other than writing code: writing 1. Ensure your change has an issue! Find an [existing issue](https://github.com/meilisearch/meilisearch/issues/) or [open a new issue](https://github.com/meilisearch/meilisearch/issues/new). * This is where you can get a feel if the change will be accepted or not. -2. Once approved, [fork the MeiliSearch repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own Github account. +2. Once approved, [fork the meilisearch repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own Github account. 3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository) 4. Review the [Development Workflow](#development-workflow) section that describes the steps to maintain the repository. 5. Make your changes on your branch. -6. [Submit the branch as a Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the MeiliSearch repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer. +6. [Submit the branch as a Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the meilisearch repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer. ## Development Workflow -### Setup and run MeiliSearch +### Setup and run meilisearch ```bash cargo run --release ``` -We recommend using the `--release` flag to test the full performance of MeiliSearch. +We recommend using the `--release` flag to test the full performance of meilisearch. ### Test From ae5b401e744892d7d93b3a556c61f1b5893ceeaf Mon Sep 17 00:00:00 2001 From: meili-bot <74670311+meili-bot@users.noreply.github.com> Date: Wed, 26 Jan 2022 16:31:04 +0100 Subject: [PATCH 02/10] Update README.md --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 31f8c773b..767772fd3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@

- MeiliSearch + meilisearch

-

MeiliSearch

+

meilisearch

Website | @@ -15,17 +15,17 @@

- Build Status - Dependency status - License - Slack - + Build Status + Dependency status + License + Slack + Bors enabled

⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine 🔍

-**MeiliSearch** is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box. +**meilisearch** is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box. For more information about features go to [our documentation](https://docs.meilisearch.com/).

@@ -61,13 +61,13 @@ meilisearch docker run -p 7700:7700 -v "$(pwd)/data.ms:/data.ms" getmeili/meilisearch ``` -#### Announcing a cloud-hosted MeiliSearch +#### Announcing a cloud-hosted meilisearch Join the closed beta by filling out this [form](https://meilisearch.typeform.com/to/FtnzvZfh). -#### Try MeiliSearch in our Sandbox +#### Try meilisearch in our Sandbox -Create a MeiliSearch instance in [MeiliSearch Sandbox](https://sandbox.meilisearch.com/). This instance is free, and will be active for 48 hours. +Create a meilisearch instance in [meilisearch Sandbox](https://sandbox.meilisearch.com/). This instance is free, and will be active for 48 hours. #### Run on Digital Ocean @@ -99,8 +99,8 @@ curl -L https://install.meilisearch.com | sh If you have the latest stable Rust toolchain installed on your local system, clone the repository and change it to your working directory. ```bash -git clone https://github.com/meilisearch/MeiliSearch.git -cd MeiliSearch +git clone https://github.com/meilisearch/meilisearch.git +cd meilisearch cargo run --release ``` @@ -161,19 +161,19 @@ curl 'http://127.0.0.1:7700/indexes/movies/search?q=botman+robin&limit=2' | jq #### Use the Web Interface -We also deliver an **out-of-the-box [web interface](https://github.com/meilisearch/mini-dashboard)** in which you can test MeiliSearch interactively. +We also deliver an **out-of-the-box [web interface](https://github.com/meilisearch/mini-dashboard)** in which you can test meilisearch interactively. -You can access the web interface in your web browser at the root of the server. The default URL is [http://127.0.0.1:7700](http://127.0.0.1:7700). All you need to do is open your web browser and enter MeiliSearch’s address to visit it. This will lead you to a web page with a search bar that will allow you to search in the selected index. +You can access the web interface in your web browser at the root of the server. The default URL is [http://127.0.0.1:7700](http://127.0.0.1:7700). All you need to do is open your web browser and enter meilisearch’s address to visit it. This will lead you to a web page with a search bar that will allow you to search in the selected index. | [See the gif above](#demo) ## Documentation -Now that your MeiliSearch server is up and running, you can learn more about how to tune your search engine in [the documentation](https://docs.meilisearch.com). +Now that your meilisearch server is up and running, you can learn more about how to tune your search engine in [the documentation](https://docs.meilisearch.com). ## Contributing -Hey! We're glad you're thinking about contributing to MeiliSearch! Feel free to pick an [issue labeled as `good first issue`](https://github.com/meilisearch/MeiliSearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), and to ask any question you need. Some points might not be clear and we are available to help you! +Hey! We're glad you're thinking about contributing to meilisearch! Feel free to pick an [issue labeled as `good first issue`](https://github.com/meilisearch/meilisearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), and to ask any question you need. Some points might not be clear and we are available to help you! Also, we recommend following the [CONTRIBUTING](./CONTRIBUTING.md) to create your PR. @@ -184,8 +184,8 @@ The code in this repository is only concerned with managing multiple indexes, ha Search and indexation are the domain of our core engine, [`milli`](https://github.com/meilisearch/milli), while tokenization is handled by [our `tokenizer` library](https://github.com/meilisearch/tokenizer/). ## Telemetry -MeiliSearch collects anonymous data regarding general usage. -This helps us better understand developers' usage of MeiliSearch features. +meilisearch collects anonymous data regarding general usage. +This helps us better understand developers' usage of meilisearch features. To find out more on what information we're retrieving, please see our documentation on [Telemetry](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html). @@ -193,7 +193,7 @@ This program is optional, you can disable these analytics by using the `MEILI_NO ## Feature request -The feature requests are not managed in this repository. Please visit our [dedicated repository](https://github.com/meilisearch/product) to see our work about the MeiliSearch product. +The feature requests are not managed in this repository. Please visit our [dedicated repository](https://github.com/meilisearch/product) to see our work about the meilisearch product. If you have a feature request or any feedback about an existing feature, please open [a discussion](https://github.com/meilisearch/product/discussions). Also, feel free to participate in the current discussions, we are looking forward to reading your comments. @@ -202,4 +202,4 @@ Also, feel free to participate in the current discussions, we are looking forwar Please visit [this page](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html#contact-us). -MeiliSearch is developed by [Meili](https://www.meilisearch.com), a young company. To know more about us, you can [read our blog](https://blog.meilisearch.com). Any suggestion or feedback is highly appreciated. Thank you for your support! +meilisearch is developed by [Meili](https://www.meilisearch.com), a young company. To know more about us, you can [read our blog](https://blog.meilisearch.com). Any suggestion or feedback is highly appreciated. Thank you for your support! From 372f4fc924f36319c921fd36fbdc354d96b1d974 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 26 Jan 2022 17:34:31 +0100 Subject: [PATCH 03/10] Replace logo --- assets/logo.svg | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/assets/logo.svg b/assets/logo.svg index e61b86003..a11654929 100644 --- a/assets/logo.svg +++ b/assets/logo.svg @@ -1,17 +1,19 @@ - - - - - - + + + + - - - + + + - - - + + + + + + + From 0a78750465beaba8ea7d70bd49d860055e2c47f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 26 Jan 2022 17:35:56 +0100 Subject: [PATCH 04/10] Replace meilisearch by Meilisearch --- CONTRIBUTING.md | 15 ++++++++------- README.md | 26 +++++++++++++------------- 2 files changed, 21 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 130f62780..8a0ac1b44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,11 @@ # Contributing -First, thank you for contributing to meilisearch! The goal of this document is to provide everything you need to start contributing to meilisearch. +First, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to start contributing to Meilisearch. Remember that there are many ways to contribute other than writing code: writing [tutorials or blog posts](https://github.com/meilisearch/awesome-meilisearch), improving [the documentation](https://github.com/meilisearch/documentation), submitting [bug reports](https://github.com/meilisearch/meilisearch/issues/new?assignees=&labels=&template=bug_report.md&title=) and [feature requests](https://github.com/meilisearch/product/discussions/categories/feedback-feature-proposal)... ## Table of Contents +- [Table of Contents](#table-of-contents) - [Assumptions](#assumptions) - [How to Contribute](#how-to-contribute) - [Development Workflow](#development-workflow) @@ -13,8 +14,8 @@ Remember that there are many ways to contribute other than writing code: writing ## Assumptions 1. **You're familiar with [Github](https://github.com) and the [Pull Requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.** -2. **You've read the meilisearch [documentation](https://docs.meilisearch.com).** -3. **You know about the [meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). +2. **You've read the Meilisearch [documentation](https://docs.meilisearch.com).** +3. **You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.** ## How to Contribute @@ -22,21 +23,21 @@ Remember that there are many ways to contribute other than writing code: writing 1. Ensure your change has an issue! Find an [existing issue](https://github.com/meilisearch/meilisearch/issues/) or [open a new issue](https://github.com/meilisearch/meilisearch/issues/new). * This is where you can get a feel if the change will be accepted or not. -2. Once approved, [fork the meilisearch repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own Github account. +2. Once approved, [fork the Meilisearch repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own Github account. 3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository) 4. Review the [Development Workflow](#development-workflow) section that describes the steps to maintain the repository. 5. Make your changes on your branch. -6. [Submit the branch as a Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the meilisearch repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer. +6. [Submit the branch as a Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the Meilisearch repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer. ## Development Workflow -### Setup and run meilisearch +### Setup and run Meilisearch ```bash cargo run --release ``` -We recommend using the `--release` flag to test the full performance of meilisearch. +We recommend using the `--release` flag to test the full performance of Meilisearch. ### Test diff --git a/README.md b/README.md index 767772fd3..c0a56971c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@

- meilisearch + Meilisearch

-

meilisearch

+

Meilisearch

Website | @@ -25,7 +25,7 @@

⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine 🔍

-**meilisearch** is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box. +**Meilisearch** is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box. For more information about features go to [our documentation](https://docs.meilisearch.com/).

@@ -61,13 +61,13 @@ meilisearch docker run -p 7700:7700 -v "$(pwd)/data.ms:/data.ms" getmeili/meilisearch ``` -#### Announcing a cloud-hosted meilisearch +#### Announcing a cloud-hosted Meilisearch Join the closed beta by filling out this [form](https://meilisearch.typeform.com/to/FtnzvZfh). -#### Try meilisearch in our Sandbox +#### Try Meilisearch in our Sandbox -Create a meilisearch instance in [meilisearch Sandbox](https://sandbox.meilisearch.com/). This instance is free, and will be active for 48 hours. +Create a Meilisearch instance in [Meilisearch Sandbox](https://sandbox.meilisearch.com/). This instance is free, and will be active for 48 hours. #### Run on Digital Ocean @@ -161,19 +161,19 @@ curl 'http://127.0.0.1:7700/indexes/movies/search?q=botman+robin&limit=2' | jq #### Use the Web Interface -We also deliver an **out-of-the-box [web interface](https://github.com/meilisearch/mini-dashboard)** in which you can test meilisearch interactively. +We also deliver an **out-of-the-box [web interface](https://github.com/meilisearch/mini-dashboard)** in which you can test Meilisearch interactively. -You can access the web interface in your web browser at the root of the server. The default URL is [http://127.0.0.1:7700](http://127.0.0.1:7700). All you need to do is open your web browser and enter meilisearch’s address to visit it. This will lead you to a web page with a search bar that will allow you to search in the selected index. +You can access the web interface in your web browser at the root of the server. The default URL is [http://127.0.0.1:7700](http://127.0.0.1:7700). All you need to do is open your web browser and enter Meilisearch’s address to visit it. This will lead you to a web page with a search bar that will allow you to search in the selected index. | [See the gif above](#demo) ## Documentation -Now that your meilisearch server is up and running, you can learn more about how to tune your search engine in [the documentation](https://docs.meilisearch.com). +Now that your Meilisearch server is up and running, you can learn more about how to tune your search engine in [the documentation](https://docs.meilisearch.com). ## Contributing -Hey! We're glad you're thinking about contributing to meilisearch! Feel free to pick an [issue labeled as `good first issue`](https://github.com/meilisearch/meilisearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), and to ask any question you need. Some points might not be clear and we are available to help you! +Hey! We're glad you're thinking about contributing to Meilisearch! Feel free to pick an [issue labeled as `good first issue`](https://github.com/meilisearch/meilisearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), and to ask any question you need. Some points might not be clear and we are available to help you! Also, we recommend following the [CONTRIBUTING](./CONTRIBUTING.md) to create your PR. @@ -184,7 +184,7 @@ The code in this repository is only concerned with managing multiple indexes, ha Search and indexation are the domain of our core engine, [`milli`](https://github.com/meilisearch/milli), while tokenization is handled by [our `tokenizer` library](https://github.com/meilisearch/tokenizer/). ## Telemetry -meilisearch collects anonymous data regarding general usage. +Meilisearch collects anonymous data regarding general usage. This helps us better understand developers' usage of meilisearch features. To find out more on what information we're retrieving, please see our documentation on [Telemetry](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html). @@ -193,7 +193,7 @@ This program is optional, you can disable these analytics by using the `MEILI_NO ## Feature request -The feature requests are not managed in this repository. Please visit our [dedicated repository](https://github.com/meilisearch/product) to see our work about the meilisearch product. +The feature requests are not managed in this repository. Please visit our [dedicated repository](https://github.com/meilisearch/product) to see our work about the Meilisearch product. If you have a feature request or any feedback about an existing feature, please open [a discussion](https://github.com/meilisearch/product/discussions). Also, feel free to participate in the current discussions, we are looking forward to reading your comments. @@ -202,4 +202,4 @@ Also, feel free to participate in the current discussions, we are looking forwar Please visit [this page](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html#contact-us). -meilisearch is developed by [Meili](https://www.meilisearch.com), a young company. To know more about us, you can [read our blog](https://blog.meilisearch.com). Any suggestion or feedback is highly appreciated. Thank you for your support! +Meilisearch is developed by [Meili](https://www.meilisearch.com), a young company. To know more about us, you can [read our blog](https://blog.meilisearch.com). Any suggestion or feedback is highly appreciated. Thank you for your support! From 8a959da1201295d812d7b454ba90080f81f8d1f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 26 Jan 2022 17:43:16 +0100 Subject: [PATCH 05/10] Update MeiliSearch into Meilisearch everywhere --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/is-latest-release.sh | 2 +- .github/workflows/README.md | 2 +- SECURITY.md | 8 ++++---- download-latest.sh | 16 ++++++++-------- meilisearch-http/Cargo.toml | 2 +- meilisearch-http/src/analytics/mod.rs | 8 ++++---- .../src/analytics/segment_analytics.rs | 2 +- meilisearch-http/src/main.rs | 4 ++-- meilisearch-http/src/routes/mod.rs | 4 ++-- meilisearch-lib/src/index/search.rs | 2 +- .../src/index_controller/versioning/error.rs | 6 +++--- .../src/index_controller/versioning/mod.rs | 4 ++-- meilisearch-lib/src/tasks/task.rs | 4 ++-- meilisearch-lib/src/tasks/task_store/store.rs | 2 +- 16 files changed, 36 insertions(+), 36 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index cea573edf..4ce2db180 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -23,8 +23,8 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**MeiliSearch version:** [e.g. v0.20.0] +**Meilisearch version:** [e.g. v0.20.0] **Additional context** Additional information that may be relevant to the issue. -[e.g. architecture, device, OS, browser] \ No newline at end of file +[e.g. architecture, device, OS, browser] diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c48a05c91..4997861fb 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -6,5 +6,5 @@ contact_links: url: https://github.com/meilisearch/documentation/issues/new about: For documentation issues, open an issue or a PR in the documentation repository - name: Support questions & other - url: https://github.com/meilisearch/MeiliSearch/discussions/new + url: https://github.com/meilisearch/meilisearch/discussions/new about: For any other question, open a discussion in this repository diff --git a/.github/is-latest-release.sh b/.github/is-latest-release.sh index b30c6138b..77e3ad9a0 100644 --- a/.github/is-latest-release.sh +++ b/.github/is-latest-release.sh @@ -74,7 +74,7 @@ semverLT() { # Returns the tag of the latest stable release (in terms of semver and not of release date) get_latest() { temp_file='temp_file' # temp_file needed because the grep would start before the download is over - curl -s 'https://api.github.com/repos/meilisearch/MeiliSearch/releases' > "$temp_file" + curl -s 'https://api.github.com/repos/meilisearch/meiliSearch/releases' > "$temp_file" releases=$(cat "$temp_file" | \ grep -E "tag_name|draft|prerelease" \ | tr -d ',"' | cut -d ':' -f2 | tr -d ' ') diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 32c32c7d6..ffb401a6c 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -1,4 +1,4 @@ -# GitHub Actions Workflow for MeiliSearch +# GitHub Actions Workflow for Meilisearch > **Note:** diff --git a/SECURITY.md b/SECURITY.md index 28775c485..63bc15a40 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,16 +1,16 @@ # Security -MeiliSearch takes the security of our software products and services seriously. +Meilisearch takes the security of our software products and services seriously. -If you believe you have found a security vulnerability in any MeiliSearch-owned repository, please report it to us as described below. +If you believe you have found a security vulnerability in any Meilisearch-owned repository, please report it to us as described below. ## Suported versions -As long as we are pre-v1.0, only the latest version of MeiliSearch will be supported with security updates. +As long as we are pre-v1.0, only the latest version of Meilisearch will be supported with security updates. ## Reporting security issues -⚠️ Please do not report security vulnerabilities through public GitHub issues. ⚠️ +⚠️ Please do not report security vulnerabilities through public GitHub issues. ⚠️ Instead, please kindly email us at security@meilisearch.com diff --git a/download-latest.sh b/download-latest.sh index 5001103e6..926f5f630 100644 --- a/download-latest.sh +++ b/download-latest.sh @@ -74,9 +74,9 @@ get_latest() { temp_file='temp_file' # temp_file needed because the grep would start before the download is over if [ -z "$GITHUB_PAT" ]; then - curl -s 'https://api.github.com/repos/meilisearch/MeiliSearch/releases' > "$temp_file" || return 1 + curl -s 'https://api.github.com/repos/meilisearch/Meilisearch/releases' > "$temp_file" || return 1 else - curl -H "Authorization: token $GITHUB_PAT" -s 'https://api.github.com/repos/meilisearch/MeiliSearch/releases' > "$temp_file" || return 1 + curl -H "Authorization: token $GITHUB_PAT" -s 'https://api.github.com/repos/meilisearch/Meilisearch/releases' > "$temp_file" || return 1 fi releases=$(cat "$temp_file" | \ @@ -161,7 +161,7 @@ get_archi() { } success_usage() { - printf "$GREEN%s\n$DEFAULT" "MeiliSearch $latest binary successfully downloaded as '$binary_name' file." + printf "$GREEN%s\n$DEFAULT" "Meilisearch $latest binary successfully downloaded as '$binary_name' file." echo '' echo 'Run it:' echo ' $ ./meilisearch' @@ -170,7 +170,7 @@ success_usage() { } failure_usage() { - printf "$RED%s\n$DEFAULT" 'ERROR: MeiliSearch binary is not available for your OS distribution or your architecture yet.' + printf "$RED%s\n$DEFAULT" 'ERROR: Meilisearch binary is not available for your OS distribution or your architecture yet.' echo '' echo 'However, you can easily compile the binary from the source files.' echo 'Follow the steps at the page ("Source" tab): https://docs.meilisearch.com/learn/getting_started/installation.html' @@ -181,8 +181,8 @@ latest="$(get_latest)" if [ "$latest" = '' ]; then echo '' - echo 'Impossible to get the latest stable version of MeiliSearch.' - echo 'Please let us know about this issue: https://github.com/meilisearch/MeiliSearch/issues/new/choose' + echo 'Impossible to get the latest stable version of Meilisearch.' + echo 'Please let us know about this issue: https://github.com/meilisearch/Meilisearch/issues/new/choose' exit 1 fi @@ -196,7 +196,7 @@ if ! get_archi; then exit 1 fi -echo "Downloading MeiliSearch binary $latest for $os, architecture $archi..." +echo "Downloading Meilisearch binary $latest for $os, architecture $archi..." case "$os" in 'windows') release_file="meilisearch-$os-$archi.exe" @@ -208,7 +208,7 @@ case "$os" in binary_name='meilisearch' esac -link="https://github.com/meilisearch/MeiliSearch/releases/download/$latest/$release_file" +link="https://github.com/meilisearch/Meilisearch/releases/download/$latest/$release_file" curl -OL "$link" mv "$release_file" "$binary_name" chmod 744 "$binary_name" diff --git a/meilisearch-http/Cargo.toml b/meilisearch-http/Cargo.toml index d1f2ead7d..fce7f3fef 100644 --- a/meilisearch-http/Cargo.toml +++ b/meilisearch-http/Cargo.toml @@ -1,6 +1,6 @@ [package] authors = ["Quentin de Quelen ", "Clément Renault "] -description = "MeiliSearch HTTP server" +description = "Meilisearch HTTP server" edition = "2021" license = "MIT" name = "meilisearch-http" diff --git a/meilisearch-http/src/analytics/mod.rs b/meilisearch-http/src/analytics/mod.rs index f777a293e..caeb7b7c0 100644 --- a/meilisearch-http/src/analytics/mod.rs +++ b/meilisearch-http/src/analytics/mod.rs @@ -29,12 +29,12 @@ pub type SegmentAnalytics = segment_analytics::SegmentAnalytics; #[cfg(all(not(debug_assertions), feature = "analytics"))] pub type SearchAggregator = segment_analytics::SearchAggregator; -/// The MeiliSearch config dir: -/// `~/.config/MeiliSearch` on *NIX or *BSD. +/// The Meilisearch config dir: +/// `~/.config/Meilisearch` on *NIX or *BSD. /// `~/Library/ApplicationSupport` on macOS. /// `%APPDATA` (= `C:\Users%USERNAME%\AppData\Roaming`) on windows. static MEILISEARCH_CONFIG_PATH: Lazy> = - Lazy::new(|| AppDirs::new(Some("MeiliSearch"), false).map(|appdir| appdir.config_dir)); + Lazy::new(|| AppDirs::new(Some("Meilisearch"), false).map(|appdir| appdir.config_dir)); fn config_user_id_path(db_path: &Path) -> Option { db_path @@ -50,7 +50,7 @@ fn config_user_id_path(db_path: &Path) -> Option { .map(|(filename, config_path)| config_path.join(filename.trim_start_matches('-'))) } -/// Look for the instance-uid in the `data.ms` or in `~/.config/MeiliSearch/path-to-db-instance-uid` +/// Look for the instance-uid in the `data.ms` or in `~/.config/Meilisearch/path-to-db-instance-uid` fn find_user_id(db_path: &Path) -> Option { fs::read_to_string(db_path.join("instance-uid")) .ok() diff --git a/meilisearch-http/src/analytics/segment_analytics.rs b/meilisearch-http/src/analytics/segment_analytics.rs index ab161c3dc..86eb8f29e 100644 --- a/meilisearch-http/src/analytics/segment_analytics.rs +++ b/meilisearch-http/src/analytics/segment_analytics.rs @@ -78,7 +78,7 @@ impl SegmentAnalytics { let user = User::UserId { user_id }; let mut batcher = AutoBatcher::new(client, Batcher::new(None), SEGMENT_API_KEY.to_string()); - // If MeiliSearch is Launched for the first time: + // If Meilisearch is Launched for the first time: // 1. Send an event Launched associated to the user `total_launch`. // 2. Batch an event Launched with the real instance-id and send it in one hour. if first_time_run { diff --git a/meilisearch-http/src/main.rs b/meilisearch-http/src/main.rs index 9ca1fecfe..cda7c2ef8 100644 --- a/meilisearch-http/src/main.rs +++ b/meilisearch-http/src/main.rs @@ -128,7 +128,7 @@ pub fn print_launch_resume(opt: &Opt, user: &str) { if !opt.no_analytics { eprintln!( " -Thank you for using MeiliSearch! +Thank you for using Meilisearch! We collect anonymized analytics to improve our product and your experience. To learn more, including how to turn off analytics, visit our dedicated documentation page: https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html @@ -146,7 +146,7 @@ Anonymous telemetry:\t\"Enabled\"" eprintln!(); if opt.master_key.is_some() { - eprintln!("A Master Key has been set. Requests to MeiliSearch won't be authorized unless you provide an authentication key."); + eprintln!("A Master Key has been set. Requests to Meilisearch won't be authorized unless you provide an authentication key."); } else { eprintln!("No master key found; The server will accept unidentified requests. \ If you need some protection in development mode, please export a key: export MEILI_MASTER_KEY=xxx"); diff --git a/meilisearch-http/src/routes/mod.rs b/meilisearch-http/src/routes/mod.rs index c859dc68f..5ec9cfee4 100644 --- a/meilisearch-http/src/routes/mod.rs +++ b/meilisearch-http/src/routes/mod.rs @@ -117,11 +117,11 @@ impl IndexUpdateResponse { /// Always return a 200 with: /// ```json /// { -/// "status": "MeiliSearch is running" +/// "status": "Meilisearch is running" /// } /// ``` pub async fn running() -> HttpResponse { - HttpResponse::Ok().json(serde_json::json!({ "status": "MeiliSearch is running" })) + HttpResponse::Ok().json(serde_json::json!({ "status": "Meilisearch is running" })) } async fn get_stats( diff --git a/meilisearch-lib/src/index/search.rs b/meilisearch-lib/src/index/search.rs index 3f05e7dc1..99c4e8bf3 100644 --- a/meilisearch-lib/src/index/search.rs +++ b/meilisearch-lib/src/index/search.rs @@ -877,7 +877,7 @@ mod test { assert_eq!(value["publication_year"], "1937"); } - /// https://github.com/meilisearch/MeiliSearch/issues/1368 + /// https://github.com/meilisearch/meilisearch/issues/1368 #[test] fn formatted_with_highlight_emoji() { let stop_words = fst::Set::default(); diff --git a/meilisearch-lib/src/index_controller/versioning/error.rs b/meilisearch-lib/src/index_controller/versioning/error.rs index ef7688bfb..ba284ec91 100644 --- a/meilisearch-lib/src/index_controller/versioning/error.rs +++ b/meilisearch-lib/src/index_controller/versioning/error.rs @@ -1,14 +1,14 @@ #[derive(thiserror::Error, Debug)] pub enum VersionFileError { #[error( - "MeilSearch (v{}) failed to infer the version of the database. Please consider using a dump to load your data.", + "Meilisearch (v{}) failed to infer the version of the database. Please consider using a dump to load your data.", env!("CARGO_PKG_VERSION").to_string() )] MissingVersionFile, - #[error("Version file is corrupted and thus MeiliSearch is unable to determine the version of the database.")] + #[error("Version file is corrupted and thus Meilisearch is unable to determine the version of the database.")] MalformedVersionFile, #[error( - "Expected MeiliSearch engine version: {major}.{minor}.{patch}, current engine version: {}. To update MeiliSearch use a dump.", + "Expected Meilisearch engine version: {major}.{minor}.{patch}, current engine version: {}. To update Meilisearch use a dump.", env!("CARGO_PKG_VERSION").to_string() )] VersionMismatch { diff --git a/meilisearch-lib/src/index_controller/versioning/mod.rs b/meilisearch-lib/src/index_controller/versioning/mod.rs index 4de894ebb..f2c83bdad 100644 --- a/meilisearch-lib/src/index_controller/versioning/mod.rs +++ b/meilisearch-lib/src/index_controller/versioning/mod.rs @@ -12,7 +12,7 @@ static VERSION_MAJOR: &str = env!("CARGO_PKG_VERSION_MAJOR"); static VERSION_MINOR: &str = env!("CARGO_PKG_VERSION_MINOR"); static VERSION_PATCH: &str = env!("CARGO_PKG_VERSION_PATCH"); -// Persists the version of the current MeiliSearch binary to a VERSION file +// Persists the version of the current Meilisearch binary to a VERSION file pub fn create_version_file(db_path: &Path) -> anyhow::Result<()> { let version_path = db_path.join(VERSION_FILE_NAME); fs::write( @@ -23,7 +23,7 @@ pub fn create_version_file(db_path: &Path) -> anyhow::Result<()> { Ok(()) } -// Ensures MeiliSearch version is compatible with the database, returns an error versions mismatch. +// Ensures Meilisearch version is compatible with the database, returns an error versions mismatch. pub fn check_version_file(db_path: &Path) -> anyhow::Result<()> { let version_path = db_path.join(VERSION_FILE_NAME); diff --git a/meilisearch-lib/src/tasks/task.rs b/meilisearch-lib/src/tasks/task.rs index add07f2ad..f5dd8d9be 100644 --- a/meilisearch-lib/src/tasks/task.rs +++ b/meilisearch-lib/src/tasks/task.rs @@ -55,7 +55,7 @@ pub enum TaskEvent { }, } -/// A task represents an operation that MeiliSearch must do. +/// A task represents an operation that Meilisearch must do. /// It's stored on disk and executed from the lowest to highest Task id. /// Everytime a new task is created it has a higher Task id than the previous one. /// See also `Job`. @@ -91,7 +91,7 @@ impl Task { /// A job is like a volatile priority `Task`. /// It should be processed as fast as possible and is not stored on disk. -/// This means, when MeiliSearch is closed all your unprocessed jobs will disappear. +/// This means, when Meilisearch is closed all your unprocessed jobs will disappear. #[derive(Debug, derivative::Derivative)] #[derivative(PartialEq)] pub enum Job { diff --git a/meilisearch-lib/src/tasks/task_store/store.rs b/meilisearch-lib/src/tasks/task_store/store.rs index 52b001dc7..49413f167 100644 --- a/meilisearch-lib/src/tasks/task_store/store.rs +++ b/meilisearch-lib/src/tasks/task_store/store.rs @@ -87,7 +87,7 @@ impl Store { /// This function should be called *right after* creating the store. /// It put back all unfinished update in the `Created` state. This /// allow us to re-enqueue an update that didn't had the time to finish - /// when MeiliSearch closed. + /// when Meilisearch closed. pub fn reset_and_return_unfinished_tasks(&mut self) -> Result>> { let mut unfinished_tasks: BinaryHeap> = BinaryHeap::new(); From a5759139bf89b1ad3859eb31ac46f4ba5623eacc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 26 Jan 2022 17:51:38 +0100 Subject: [PATCH 06/10] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Clément Renault --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a0ac1b44..c2674c4d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,6 @@ First, thank you for contributing to Meilisearch! The goal of this document is t Remember that there are many ways to contribute other than writing code: writing [tutorials or blog posts](https://github.com/meilisearch/awesome-meilisearch), improving [the documentation](https://github.com/meilisearch/documentation), submitting [bug reports](https://github.com/meilisearch/meilisearch/issues/new?assignees=&labels=&template=bug_report.md&title=) and [feature requests](https://github.com/meilisearch/product/discussions/categories/feedback-feature-proposal)... ## Table of Contents -- [Table of Contents](#table-of-contents) - [Assumptions](#assumptions) - [How to Contribute](#how-to-contribute) - [Development Workflow](#development-workflow) From db56d6cb116bc4c26a8ffdb4d4d181db1f6c8e86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 26 Jan 2022 17:54:22 +0100 Subject: [PATCH 07/10] Update download-latest.sh --- download-latest.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/download-latest.sh b/download-latest.sh index 926f5f630..cf6146c2f 100644 --- a/download-latest.sh +++ b/download-latest.sh @@ -182,7 +182,7 @@ latest="$(get_latest)" if [ "$latest" = '' ]; then echo '' echo 'Impossible to get the latest stable version of Meilisearch.' - echo 'Please let us know about this issue: https://github.com/meilisearch/Meilisearch/issues/new/choose' + echo 'Please let us know about this issue: https://github.com/meilisearch/meilisearch/issues/new/choose' exit 1 fi From 3bc6a18bcdd1e43f614f8bff2fa77a8c110f6c22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar=20-=20curqui?= Date: Wed, 26 Jan 2022 17:54:51 +0100 Subject: [PATCH 08/10] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Clément Renault --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c0a56971c..9efb5a937 100644 --- a/README.md +++ b/README.md @@ -185,7 +185,7 @@ Search and indexation are the domain of our core engine, [`milli`](https://githu ## Telemetry Meilisearch collects anonymous data regarding general usage. -This helps us better understand developers' usage of meilisearch features. +This helps us better understand developers' usage of Meilisearch features. To find out more on what information we're retrieving, please see our documentation on [Telemetry](https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html). From 2b7440d4b5ada816206a1d598e44bda03d299660 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 26 Jan 2022 17:56:18 +0100 Subject: [PATCH 09/10] Fix some typo --- download-latest.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/download-latest.sh b/download-latest.sh index cf6146c2f..4e88c1828 100644 --- a/download-latest.sh +++ b/download-latest.sh @@ -74,9 +74,9 @@ get_latest() { temp_file='temp_file' # temp_file needed because the grep would start before the download is over if [ -z "$GITHUB_PAT" ]; then - curl -s 'https://api.github.com/repos/meilisearch/Meilisearch/releases' > "$temp_file" || return 1 + curl -s 'https://api.github.com/repos/meilisearch/meilisearch/releases' > "$temp_file" || return 1 else - curl -H "Authorization: token $GITHUB_PAT" -s 'https://api.github.com/repos/meilisearch/Meilisearch/releases' > "$temp_file" || return 1 + curl -H "Authorization: token $GITHUB_PAT" -s 'https://api.github.com/repos/meilisearch/meilisearch/releases' > "$temp_file" || return 1 fi releases=$(cat "$temp_file" | \ @@ -208,7 +208,7 @@ case "$os" in binary_name='meilisearch' esac -link="https://github.com/meilisearch/Meilisearch/releases/download/$latest/$release_file" +link="https://github.com/meilisearch/meilisearch/releases/download/$latest/$release_file" curl -OL "$link" mv "$release_file" "$binary_name" chmod 744 "$binary_name" From 72d9c5ee5c16867e6af8e541717de77dcaf2937b Mon Sep 17 00:00:00 2001 From: Tamo Date: Wed, 26 Jan 2022 18:53:07 +0100 Subject: [PATCH 10/10] fix(rebranding): Update the ascii art (#2118) --- meilisearch-http/src/main.rs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/meilisearch-http/src/main.rs b/meilisearch-http/src/main.rs index cda7c2ef8..498bbb82d 100644 --- a/meilisearch-http/src/main.rs +++ b/meilisearch-http/src/main.rs @@ -101,14 +101,14 @@ pub fn print_launch_resume(opt: &Opt, user: &str) { let commit_date = option_env!("VERGEN_GIT_COMMIT_TIMESTAMP").unwrap_or("unknown"); let ascii_name = r#" -888b d888 d8b 888 d8b .d8888b. 888 -8888b d8888 Y8P 888 Y8P d88P Y88b 888 -88888b.d88888 888 Y88b. 888 -888Y88888P888 .d88b. 888 888 888 "Y888b. .d88b. 8888b. 888d888 .d8888b 88888b. -888 Y888P 888 d8P Y8b 888 888 888 "Y88b. d8P Y8b "88b 888P" d88P" 888 "88b -888 Y8P 888 88888888 888 888 888 "888 88888888 .d888888 888 888 888 888 -888 " 888 Y8b. 888 888 888 Y88b d88P Y8b. 888 888 888 Y88b. 888 888 -888 888 "Y8888 888 888 888 "Y8888P" "Y8888 "Y888888 888 "Y8888P 888 888 +888b d888 d8b 888 d8b 888 +8888b d8888 Y8P 888 Y8P 888 +88888b.d88888 888 888 +888Y88888P888 .d88b. 888 888 888 .d8888b .d88b. 8888b. 888d888 .d8888b 88888b. +888 Y888P 888 d8P Y8b 888 888 888 88K d8P Y8b "88b 888P" d88P" 888 "88b +888 Y8P 888 88888888 888 888 888 "Y8888b. 88888888 .d888888 888 888 888 888 +888 " 888 Y8b. 888 888 888 X88 Y8b. 888 888 888 Y88b. 888 888 +888 888 "Y8888 888 888 888 88888P' "Y8888 "Y888888 888 "Y8888P 888 888 "#; eprintln!("{}", ascii_name);