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/CONTRIBUTING.md b/CONTRIBUTING.md index bef47a651..c2674c4d1 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 diff --git a/README.md b/README.md index 31f8c773b..9efb5a937 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@
- +
-⚡ 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! 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/assets/logo.svg b/assets/logo.svg index e61b86003..a11654929 100644 --- a/assets/logo.svg +++ b/assets/logo.svg @@ -1,17 +1,19 @@ -