From 35c6d7df86dd6bd8a7d6fce2f4d3179a07004734 Mon Sep 17 00:00:00 2001 From: Dries Vints Date: Fri, 3 Sep 2021 13:29:58 +0200 Subject: [PATCH 1/4] Update scout.md --- scout.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/scout.md b/scout.md index 106864215ac..8b4b937ba9d 100644 --- a/scout.md +++ b/scout.md @@ -4,6 +4,7 @@ - [Installation](#installation) - [Driver Prerequisites](#driver-prerequisites) - [Queueing](#queueing) +- [Upgrading Scout](#upgrading-scout) - [Configuration](#configuration) - [Configuring Model Indexes](#configuring-model-indexes) - [Configuring Searchable Data](#configuring-searchable-data) @@ -92,6 +93,11 @@ While not strictly required to use Scout, you should strongly consider configuri Once you have configured a queue driver, set the value of the `queue` option in your `config/scout.php` configuration file to `true`: 'queue' => true, + + +## Upgrading Scout + +When upgrading the Scout and you're using the Meilisearch driver you should always [review any additional breaking changes](https://github.com/meilisearch/MeiliSearch/releases) when also upgrading your Meilisearch binary. ## Configuration From 6bf35108917349e6ba695a33db88cf54fd3ca575 Mon Sep 17 00:00:00 2001 From: Dries Vints Date: Fri, 3 Sep 2021 15:20:14 +0200 Subject: [PATCH 2/4] Update scout.md --- scout.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scout.md b/scout.md index 8b4b937ba9d..e65963c40ce 100644 --- a/scout.md +++ b/scout.md @@ -81,7 +81,7 @@ Then, set the `SCOUT_DRIVER` environment variable as well as your MeiliSearch `h MEILISEARCH_HOST=http://127.0.0.1:7700 MEILISEARCH_KEY=masterKey -For more information regarding MeiliSearch, please consult the [MeiliSearch documentation](https://docs.meilisearch.com/learn/getting_started/quick_start.html). +For more information regarding MeiliSearch, please consult the [MeiliSearch documentation](https://docs.meilisearch.com/learn/getting_started/quick_start.html). Make sure you install a version of `meilisearch/meilisearch-php` that is compatible with your meilisearch binary version. You can check compatibility [here](https://github.com/meilisearch/meilisearch-php#-compatibility-with-meilisearch). > {tip} If you aren't sure how to install MeiliSearch on your local machine, you may use [Laravel Sail](/docs/{{version}}/sail#meilisearch), Laravel's officially supported Docker development environment. From 8dd50df9ba161340cf11a70489d998a81fe1ba95 Mon Sep 17 00:00:00 2001 From: Taylor Otwell Date: Fri, 3 Sep 2021 09:55:19 -0500 Subject: [PATCH 3/4] Update scout.md --- scout.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/scout.md b/scout.md index e65963c40ce..47598a6d4c5 100644 --- a/scout.md +++ b/scout.md @@ -81,7 +81,9 @@ Then, set the `SCOUT_DRIVER` environment variable as well as your MeiliSearch `h MEILISEARCH_HOST=http://127.0.0.1:7700 MEILISEARCH_KEY=masterKey -For more information regarding MeiliSearch, please consult the [MeiliSearch documentation](https://docs.meilisearch.com/learn/getting_started/quick_start.html). Make sure you install a version of `meilisearch/meilisearch-php` that is compatible with your meilisearch binary version. You can check compatibility [here](https://github.com/meilisearch/meilisearch-php#-compatibility-with-meilisearch). +For more information regarding MeiliSearch, please consult the [MeiliSearch documentation](https://docs.meilisearch.com/learn/getting_started/quick_start.html). + +In addition, you should ensure that you install a version of `meilisearch/meilisearch-php` that is compatible with your MeiliSearch binary version by reviewing [MeiliSearch's documentation regarding binary compatibility](https://github.com/meilisearch/meilisearch-php#-compatibility-with-meilisearch). > {tip} If you aren't sure how to install MeiliSearch on your local machine, you may use [Laravel Sail](/docs/{{version}}/sail#meilisearch), Laravel's officially supported Docker development environment. From 479d7bf8cc5dc06268dac271b5ccb7881f01160e Mon Sep 17 00:00:00 2001 From: Taylor Otwell Date: Fri, 3 Sep 2021 09:59:37 -0500 Subject: [PATCH 4/4] Update scout.md --- scout.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/scout.md b/scout.md index 47598a6d4c5..f380f1cdfa5 100644 --- a/scout.md +++ b/scout.md @@ -71,6 +71,8 @@ When using the Algolia driver, you should configure your Algolia `id` and `secre #### MeiliSearch +[MeiliSearch](https://www.meilisearch.com) is a blazingly fast and open source search engine. If you aren't sure how to install MeiliSearch on your local machine, you may use [Laravel Sail](/docs/{{version}}/sail#meilisearch), Laravel's officially supported Docker development environment. + When using the MeiliSearch driver you will need to install the MeiliSearch PHP SDK via the Composer package manager: composer require meilisearch/meilisearch-php http-interop/http-factory-guzzle @@ -85,7 +87,7 @@ For more information regarding MeiliSearch, please consult the [MeiliSearch docu In addition, you should ensure that you install a version of `meilisearch/meilisearch-php` that is compatible with your MeiliSearch binary version by reviewing [MeiliSearch's documentation regarding binary compatibility](https://github.com/meilisearch/meilisearch-php#-compatibility-with-meilisearch). -> {tip} If you aren't sure how to install MeiliSearch on your local machine, you may use [Laravel Sail](/docs/{{version}}/sail#meilisearch), Laravel's officially supported Docker development environment. +> {note} When upgrading Scout on an application that utilizes MeiliSearch, you should always [review any additional breaking changes](https://github.com/meilisearch/MeiliSearch/releases) to the MeiliSearch service itself. ### Queueing @@ -95,11 +97,6 @@ While not strictly required to use Scout, you should strongly consider configuri Once you have configured a queue driver, set the value of the `queue` option in your `config/scout.php` configuration file to `true`: 'queue' => true, - - -## Upgrading Scout - -When upgrading the Scout and you're using the Meilisearch driver you should always [review any additional breaking changes](https://github.com/meilisearch/MeiliSearch/releases) when also upgrading your Meilisearch binary. ## Configuration