From 1a3c2e4005922771348c3016adf9c2678ce436c4 Mon Sep 17 00:00:00 2001 From: meili-bot <74670311+meili-bot@users.noreply.github.com> Date: Thu, 1 Jun 2023 07:51:27 -0300 Subject: [PATCH 1/4] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 19ac1d91..c5242e8f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Discord | Roadmap | Website | - FAQ + FAQ

@@ -39,7 +39,7 @@ This readme contains all the documentation you need to start using this Meilisearch SDK. -For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://docs.meilisearch.com/). +For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://www.meilisearch.com/docs/). ## 🔧 Installation @@ -51,7 +51,7 @@ go get github.com/meilisearch/meilisearch-go ### Run Meilisearch -There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch). +There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/reference/features/installation.html#download-and-launch). For example, using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/): @@ -106,7 +106,7 @@ func main() { } ``` -With the `taskUID`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task endpoint](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html#task-status). +With the `taskUID`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task endpoint](https://www.meilisearch.com/docs/learn/advanced/asynchronous_operations.html#task-status). #### Basic Search @@ -152,7 +152,7 @@ JSON output: #### Custom Search -All the supported options are described in the [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html) section of the documentation. +All the supported options are described in the [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters) section of the documentation. ```go func main() { @@ -200,7 +200,7 @@ task, err := index.UpdateFilterableAttributes(&[]string{"id", "genres"}) You only need to perform this operation once. -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 status](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html#task-status). +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 status](https://www.meilisearch.com/docs/learn/advanced/asynchronous_operations.html#task-status). Then, you can perform the search: @@ -236,10 +236,10 @@ This package guarantees compatibility with [version v1.x of Meilisearch](https:/ The following sections in our main documentation website may interest you: -- **Manipulate documents**: see the [API references](https://docs.meilisearch.com/reference/api/documents.html) or read more about [documents](https://docs.meilisearch.com/learn/core_concepts/documents.html). -- **Search**: see the [API references](https://docs.meilisearch.com/reference/api/search.html) or follow our guide on [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html). -- **Manage the indexes**: see the [API references](https://docs.meilisearch.com/reference/api/indexes.html) or read more about [indexes](https://docs.meilisearch.com/learn/core_concepts/indexes.html). -- **ClientConfigure the index settings**: see the [API references](https://docs.meilisearch.com/reference/api/settings.html) or follow our guide on [settings parameters](https://docs.meilisearch.com/reference/features/settings.html). +- **Manipulate documents**: see the [API references](https://www.meilisearch.com/docs/reference/api/documents) or read more about [documents](https://www.meilisearch.com/docs/learn/core_concepts/documents.html). +- **Search**: see the [API references](https://www.meilisearch.com/docs/reference/api/search) or follow our guide on [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters). +- **Manage the indexes**: see the [API references](https://www.meilisearch.com/docs/reference/api/indexes) or read more about [indexes](https://www.meilisearch.com/docs/learn/core_concepts/indexes.html). +- **ClientConfigure the index settings**: see the [API references](https://www.meilisearch.com/docs/reference/api/settings) or follow our guide on [settings parameters](https://www.meilisearch.com/docs/reference/api/settings#settings_parameters). ## ⚙️ Contributing From f72f2224bcd70ed2a3d34a67819c45ff4735f247 Mon Sep 17 00:00:00 2001 From: meili-bot <74670311+meili-bot@users.noreply.github.com> Date: Thu, 1 Jun 2023 07:51:28 -0300 Subject: [PATCH 2/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 225b7932..77036bd5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume 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.** 2. **You've read the Meilisearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).** -3. **You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.** +3. **You know about the [Meilisearch community](https://www.meilisearch.com/docs/learn/what_is_meilisearch/contact.html). Please use this for help.** ## How to Contribute From 01e2e6308acb61ee6ac9672ae0b2c9e1fae082a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Am=C3=A9lie?= Date: Thu, 1 Jun 2023 13:28:07 +0200 Subject: [PATCH 3/4] Change url doc --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77036bd5..4784d87b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume ## Assumptions 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.** -2. **You've read the Meilisearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).** +2. **You've read the Meilisearch [documentation](https://www.meilisearch.com/docs) and the [README](/README.md).** 3. **You know about the [Meilisearch community](https://www.meilisearch.com/docs/learn/what_is_meilisearch/contact.html). Please use this for help.** ## How to Contribute From b45c34e7474d23621e230e2013c917adfcfcbd28 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Am=C3=A9lie?= Date: Thu, 1 Jun 2023 13:38:23 +0200 Subject: [PATCH 4/4] Update url doc --- README.md | 10 +++++----- index_search.go | 2 +- types.go | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c5242e8f..34ca736c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

Meilisearch | - Documentation | + Documentation | Discord | Roadmap | Website | @@ -51,7 +51,7 @@ go get github.com/meilisearch/meilisearch-go ### Run Meilisearch -There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/reference/features/installation.html#download-and-launch). +There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/learn/getting_started/installation). For example, using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/): @@ -106,7 +106,7 @@ func main() { } ``` -With the `taskUID`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task endpoint](https://www.meilisearch.com/docs/learn/advanced/asynchronous_operations.html#task-status). +With the `taskUID`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task endpoint](https://www.meilisearch.com/docs/reference/api/tasks). #### Basic Search @@ -200,7 +200,7 @@ task, err := index.UpdateFilterableAttributes(&[]string{"id", "genres"}) You only need to perform this operation once. -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 status](https://www.meilisearch.com/docs/learn/advanced/asynchronous_operations.html#task-status). +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 status](https://www.meilisearch.com/docs/learn/advanced/asynchronous_operations). Then, you can perform the search: @@ -238,7 +238,7 @@ The following sections in our main documentation website may interest you: - **Manipulate documents**: see the [API references](https://www.meilisearch.com/docs/reference/api/documents) or read more about [documents](https://www.meilisearch.com/docs/learn/core_concepts/documents.html). - **Search**: see the [API references](https://www.meilisearch.com/docs/reference/api/search) or follow our guide on [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters). -- **Manage the indexes**: see the [API references](https://www.meilisearch.com/docs/reference/api/indexes) or read more about [indexes](https://www.meilisearch.com/docs/learn/core_concepts/indexes.html). +- **Manage the indexes**: see the [API references](https://www.meilisearch.com/docs/reference/api/indexes) or read more about [indexes](https://www.meilisearch.com/docs/learn/core_concepts/indexes). - **ClientConfigure the index settings**: see the [API references](https://www.meilisearch.com/docs/reference/api/settings) or follow our guide on [settings parameters](https://www.meilisearch.com/docs/reference/api/settings#settings_parameters). ## ⚙️ Contributing diff --git a/index_search.go b/index_search.go index 68ac4c31..1dba47f2 100644 --- a/index_search.go +++ b/index_search.go @@ -7,7 +7,7 @@ import ( // This constant contains the default values assigned by Meilisearch to the limit in search parameters // -// Documentation: https://docs.meilisearch.com/reference/features/search_parameters.html +// Documentation: https://www.meilisearch.com/docs/reference/api/search#search-parameters const ( DefaultLimit int64 = 20 ) diff --git a/types.go b/types.go index bf6a8a1e..0b31f22c 100644 --- a/types.go +++ b/types.go @@ -117,7 +117,7 @@ const ( // Task indicates information about a task resource // -// Documentation: https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html +// Documentation: https://www.meilisearch.com/docs/learn/advanced/asynchronous_operations type Task struct { Status TaskStatus `json:"status"` UID int64 `json:"uid,omitempty"` @@ -135,7 +135,7 @@ type Task struct { // TaskInfo indicates information regarding a task returned by an asynchronous method // -// Documentation: https://docs.meilisearch.com/reference/api/tasks.html#tasks +// Documentation: https://www.meilisearch.com/docs/reference/api/tasks#tasks type TaskInfo struct { Status TaskStatus `json:"status"` TaskUID int64 `json:"taskUid"` @@ -222,7 +222,7 @@ type TaskResult struct { // Keys allow the user to connect to the Meilisearch instance // -// Documentation: https://docs.meilisearch.com/learn/advanced/security.html#protecting-a-meilisearch-instance +// Documentation: https://www.meilisearch.com/docs/learn/security/master_api_keys#protecting-a-meilisearch-instance type Key struct { Name string `json:"name"` Description string `json:"description"` @@ -294,7 +294,7 @@ type CreateIndexRequest struct { // SearchRequest is the request url param needed for a search query. // This struct will be converted to url param before sent. // -// Documentation: https://docs.meilisearch.com/reference/features/search_parameters.html +// Documentation: https://www.meilisearch.com/docs/reference/api/search#search-parameters type SearchRequest struct { Offset int64 Limit int64