diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 564d2438b..7b0cb24e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,8 +19,8 @@ If Meilisearch does not offer optimized support for your language, please consid ## Assumptions 1. **You're familiar with [GitHub](https://github.com) and the [Pull Requests (PR)](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) 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://www.meilisearch.com/docs).** +3. **You know about the [Meilisearch community on Discord](https://discord.meilisearch.com). Please use this for help.** ## How to Contribute diff --git a/README.md b/README.md index 44cbbd4da..35479a867 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,8 @@ Website | Roadmap | Blog | - Documentation | - FAQ | + Documentation | + FAQ | Discord @@ -36,27 +36,27 @@ Meilisearch helps you shape a delightful search experience in a snap, offering f ## ✨ Features - **Search-as-you-type:** find search results in less than 50 milliseconds -- **[Typo tolerance](https://meilisearch.com/docs/learn/getting_started/customizing_relevancy#typo-tolerance):** get relevant matches even when queries contain typos and misspellings -- **[Filtering](https://meilisearch.com/docs/learn/advanced/filtering) and [faceted search](https://meilisearch.com/docs/learn/advanced/faceted_search):** enhance your user's search experience with custom filters and build a faceted search interface in a few lines of code -- **[Sorting](https://meilisearch.com/docs/learn/advanced/sorting):** sort results based on price, date, or pretty much anything else your users need -- **[Synonym support](https://meilisearch.com/docs/learn/getting_started/customizing_relevancy#synonyms):** configure synonyms to include more relevant content in your search results -- **[Geosearch](https://meilisearch.com/docs/learn/advanced/geosearch):** filter and sort documents based on geographic data -- **[Extensive language support](https://meilisearch.com/docs/learn/what_is_meilisearch/language):** search datasets in any language, with optimized support for Chinese, Japanese, Hebrew, and languages using the Latin alphabet -- **[Security management](https://meilisearch.com/docs/learn/security/master_api_keys):** control which users can access what data with API keys that allow fine-grained permissions handling -- **[Multi-Tenancy](https://meilisearch.com/docs/learn/security/tenant_tokens):** personalize search results for any number of application tenants +- **[Typo tolerance](https://www.meilisearch.com/docs/learn/getting_started/customizing_relevancy#typo-tolerance):** get relevant matches even when queries contain typos and misspellings +- **[Filtering](https://www.meilisearch.com/docs/learn/advanced/filtering) and [faceted search](https://www.meilisearch.com/docs/learn/advanced/faceted_search):** enhance your user's search experience with custom filters and build a faceted search interface in a few lines of code +- **[Sorting](https://www.meilisearch.com/docs/learn/advanced/sorting):** sort results based on price, date, or pretty much anything else your users need +- **[Synonym support](https://www.meilisearch.com/docs/learn/getting_started/customizing_relevancy#synonyms):** configure synonyms to include more relevant content in your search results +- **[Geosearch](https://www.meilisearch.com/docs/learn/advanced/geosearch):** filter and sort documents based on geographic data +- **[Extensive language support](https://www.meilisearch.com/docs/learn/what_is_meilisearch/language):** search datasets in any language, with optimized support for Chinese, Japanese, Hebrew, and languages using the Latin alphabet +- **[Security management](https://www.meilisearch.com/docs/learn/security/master_api_keys):** control which users can access what data with API keys that allow fine-grained permissions handling +- **[Multi-Tenancy](https://www.meilisearch.com/docs/learn/security/tenant_tokens):** personalize search results for any number of application tenants - **Highly Customizable:** customize Meilisearch to your specific needs or use our out-of-the-box and hassle-free presets -- **[RESTful API](https://meilisearch.com/docs/reference/api/overview):** integrate Meilisearch in your technical stack with our plugins and SDKs +- **[RESTful API](https://www.meilisearch.com/docs/reference/api/overview):** integrate Meilisearch in your technical stack with our plugins and SDKs - **Easy to install, deploy, and maintain** ## πŸ“– Documentation -You can consult Meilisearch's documentation at [https://meilisearch.com/docs](https://meilisearch.com/docs/). +You can consult Meilisearch's documentation at [https://www.meilisearch.com/docs](https://www.meilisearch.com/docs/). ## πŸš€ Getting started -For basic instructions on how to set up Meilisearch, add documents to an index, and search for documents, take a look at our [Quick Start](https://meilisearch.com/docs/learn/getting_started/quick_start) guide. +For basic instructions on how to set up Meilisearch, add documents to an index, and search for documents, take a look at our [Quick Start](https://www.meilisearch.com/docs/learn/getting_started/quick_start) guide. -You may also want to check out [Meilisearch 101](https://meilisearch.com/docs/learn/getting_started/filtering_and_sorting) for an introduction to some of Meilisearch's most popular features. +You may also want to check out [Meilisearch 101](https://www.meilisearch.com/docs/learn/getting_started/filtering_and_sorting) for an introduction to some of Meilisearch's most popular features. ## ☁️ Meilisearch cloud @@ -66,7 +66,7 @@ Let us manage your infrastructure so you can focus on integrating a great search Install one of our SDKs in your project for seamless integration between Meilisearch and your favorite language or framework! -Take a look at the complete [Meilisearch integration list](https://meilisearch.com/docs/learn/what_is_meilisearch/sdks). +Take a look at the complete [Meilisearch integration list](https://www.meilisearch.com/docs/learn/what_is_meilisearch/sdks). [![Logos belonging to different languages and frameworks supported by Meilisearch, including React, Ruby on Rails, Go, Rust, and PHP](assets/integrations.png)](https://www.meilisearch.com/docs/learn/what_is_meilisearch/sdks) @@ -74,17 +74,17 @@ Take a look at the complete [Meilisearch integration list](https://meilisearch.c Experienced users will want to keep our [API Reference](https://www.meilisearch.com/docs/reference/api/overview) close at hand. -We also offer a wide range of dedicated guides to all Meilisearch features, such as [filtering](https://meilisearch.com/docs/learn/advanced/filtering), [sorting](https://meilisearch.com/docs/learn/advanced/sorting), [geosearch](https://meilisearch.com/docs/learn/advanced/geosearch), [API keys](https://meilisearch.com/docs/learn/security/master_api_keys), and [tenant tokens](https://meilisearch.com/docs/learn/security/tenant_tokens). +We also offer a wide range of dedicated guides to all Meilisearch features, such as [filtering](https://www.meilisearch.com/docs/learn/advanced/filtering), [sorting](https://www.meilisearch.com/docs/learn/advanced/sorting), [geosearch](https://www.meilisearch.com/docs/learn/advanced/geosearch), [API keys](https://www.meilisearch.com/docs/learn/security/master_api_keys), and [tenant tokens](https://www.meilisearch.com/docs/learn/security/tenant_tokens). -Finally, for more in-depth information, refer to our articles explaining fundamental Meilisearch concepts such as [documents](https://meilisearch.com/docs/learn/core_concepts/documents) and [indexes](https://meilisearch.com/docs/learn/core_concepts/indexes). +Finally, for more in-depth information, refer to our articles explaining fundamental Meilisearch concepts such as [documents](https://www.meilisearch.com/docs/learn/core_concepts/documents) and [indexes](https://www.meilisearch.com/docs/learn/core_concepts/indexes). ## πŸ“Š Telemetry -Meilisearch collects **anonymized** data from users to help us improve our product. You can [deactivate this](https://meilisearch.com/docs/learn/what_is_meilisearch/telemetry#how-to-disable-data-collection) whenever you want. +Meilisearch collects **anonymized** data from users to help us improve our product. You can [deactivate this](https://www.meilisearch.com/docs/learn/what_is_meilisearch/telemetry#how-to-disable-data-collection) whenever you want. To request deletion of collected data, please write to us atΒ [privacy@meilisearch.com](mailto:privacy@meilisearch.com). Don't forget to include your `Instance UID` in the message, as this helps us quickly find and delete your data. -If you want to know more about the kind of data we collect and what we use it for, check the [telemetry section](https://meilisearch.com/docs/learn/what_is_meilisearch/telemetry) of our documentation. +If you want to know more about the kind of data we collect and what we use it for, check the [telemetry section](https://www.meilisearch.com/docs/learn/what_is_meilisearch/telemetry) of our documentation. ## πŸ“« Get in touch! diff --git a/benchmarks/README.md b/benchmarks/README.md index a0634bcb4..254e3eaaf 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -119,9 +119,9 @@ _[Download the `smol-wiki` dataset](https://milli-benchmarks.fra1.digitaloceansp ### Movies -`movies` is a really small dataset we uses as our example in the [getting started](https://docs.meilisearch.com/learn/getting_started/) +`movies` is a really small dataset we uses as our example in the [getting started](https://www.meilisearch.com/docs/learn/getting_started/quick_start) -_[Download the `movies` dataset](https://docs.meilisearch.com/movies.json)._ +_[Download the `movies` dataset](https://www.meilisearch.com/movies.json)._ ### All Countries diff --git a/config.toml b/config.toml index 02c9922d8..71087f25f 100644 --- a/config.toml +++ b/config.toml @@ -1,43 +1,43 @@ # This file shows the default configuration of Meilisearch. -# All variables are defined here: https://docs.meilisearch.com/learn/configuration/instance_options.html#environment-variables +# All variables are defined here: https://www.meilisearch.com/docs/learn/configuration/instance_options#environment-variables db_path = "./data.ms" # Designates the location where database files will be created and retrieved. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#database-path +# https://www.meilisearch.com/docs/learn/configuration/instance_options#database-path env = "development" # Configures the instance's environment. Value must be either `production` or `development`. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#environment +# https://www.meilisearch.com/docs/learn/configuration/instance_options#environment http_addr = "localhost:7700" # The address on which the HTTP server will listen. # master_key = "YOUR_MASTER_KEY_VALUE" # Sets the instance's master key, automatically protecting all routes except GET /health. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#master-key +# https://www.meilisearch.com/docs/learn/configuration/instance_options#master-key # no_analytics = true # Deactivates Meilisearch's built-in telemetry when provided. # Meilisearch automatically collects data from all instances that do not opt out using this flag. # All gathered data is used solely for the purpose of improving Meilisearch, and can be deleted at any time. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#disable-analytics +# https://www.meilisearch.com/docs/learn/configuration/instance_options#disable-analytics http_payload_size_limit = "100 MB" # Sets the maximum size of accepted payloads. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#payload-limit-size +# https://www.meilisearch.com/docs/learn/configuration/instance_options#payload-limit-size log_level = "INFO" # Defines how much detail should be present in Meilisearch's logs. # Meilisearch currently supports six log levels, listed in order of increasing verbosity: `OFF`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE` -# https://docs.meilisearch.com/learn/configuration/instance_options.html#log-level +# https://www.meilisearch.com/docs/learn/configuration/instance_options#log-level # max_indexing_memory = "2 GiB" # Sets the maximum amount of RAM Meilisearch can use when indexing. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#max-indexing-memory +# https://www.meilisearch.com/docs/learn/configuration/instance_options#max-indexing-memory # max_indexing_threads = 4 # Sets the maximum number of threads Meilisearch can use during indexing. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#max-indexing-threads +# https://www.meilisearch.com/docs/learn/configuration/instance_options#max-indexing-threads ############# ### DUMPS ### @@ -45,19 +45,19 @@ log_level = "INFO" dump_dir = "dumps/" # Sets the directory where Meilisearch will create dump files. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#dump-directory +# https://www.meilisearch.com/docs/learn/configuration/instance_options#dump-directory # import_dump = "./path/to/my/file.dump" # Imports the dump file located at the specified path. Path must point to a .dump file. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#import-dump +# https://www.meilisearch.com/docs/learn/configuration/instance_options#import-dump ignore_missing_dump = false # Prevents Meilisearch from throwing an error when `import_dump` does not point to a valid dump file. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#ignore-missing-dump +# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-missing-dump ignore_dump_if_db_exists = false # Prevents a Meilisearch instance with an existing database from throwing an error when using `import_dump`. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#ignore-dump-if-db-exists +# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-dump-if-db-exists ################# @@ -68,23 +68,23 @@ schedule_snapshot = false # Enables scheduled snapshots when true, disable when false (the default). # If the value is given as an integer, then enables the scheduled snapshot with the passed value as the interval # between each snapshot, in seconds. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#schedule-snapshot-creation +# https://www.meilisearch.com/docs/learn/configuration/instance_options#schedule-snapshot-creation snapshot_dir = "snapshots/" # Sets the directory where Meilisearch will store snapshots. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#snapshot-destination +# https://www.meilisearch.com/docs/learn/configuration/instance_options#snapshot-destination # import_snapshot = "./path/to/my/snapshot" # Launches Meilisearch after importing a previously-generated snapshot at the given filepath. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#import-snapshot +# https://www.meilisearch.com/docs/learn/configuration/instance_options#import-snapshot ignore_missing_snapshot = false # Prevents a Meilisearch instance from throwing an error when `import_snapshot` does not point to a valid snapshot file. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#ignore-missing-snapshot +# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-missing-snapshot ignore_snapshot_if_db_exists = false # Prevents a Meilisearch instance with an existing database from throwing an error when using `import_snapshot`. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#ignore-snapshot-if-db-exists +# https://www.meilisearch.com/docs/learn/configuration/instance_options#ignore-snapshot-if-db-exists ########### @@ -93,31 +93,31 @@ ignore_snapshot_if_db_exists = false # ssl_auth_path = "./path/to/root" # Enables client authentication in the specified path. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-authentication-path +# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-authentication-path # ssl_cert_path = "./path/to/certfile" # Sets the server's SSL certificates. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-certificates-path +# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-certificates-path # ssl_key_path = "./path/to/private-key" # Sets the server's SSL key files. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-key-path +# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-key-path # ssl_ocsp_path = "./path/to/ocsp-file" # Sets the server's OCSP file. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-ocsp-path +# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-ocsp-path ssl_require_auth = false # Makes SSL authentication mandatory. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-require-auth +# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-require-auth ssl_resumption = false # Activates SSL session resumption. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-resumption +# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-resumption ssl_tickets = false # Activates SSL tickets. -# https://docs.meilisearch.com/learn/configuration/instance_options.html#ssl-tickets +# https://www.meilisearch.com/docs/learn/configuration/instance_options#ssl-tickets ############################# ### Experimental features ### @@ -126,5 +126,3 @@ ssl_tickets = false experimental_enable_metrics = false # Experimental metrics feature. For more information, see: # Enables the Prometheus metrics on the `GET /metrics` endpoint. - - diff --git a/meilisearch/src/main.rs b/meilisearch/src/main.rs index 1b95291fd..2ab37488c 100644 --- a/meilisearch/src/main.rs +++ b/meilisearch/src/main.rs @@ -181,9 +181,9 @@ Anonymous telemetry:\t\"Enabled\"" } eprintln!(); - eprintln!("Documentation:\t\thttps://docs.meilisearch.com"); + eprintln!("Documentation:\t\thttps://www.meilisearch.com/docs"); eprintln!("Source code:\t\thttps://github.com/meilisearch/meilisearch"); - eprintln!("Contact:\t\thttps://docs.meilisearch.com/resources/contact.html"); + eprintln!("Discord:\t\thttps://discord.meilisearch.com"); eprintln!(); }