From c1eee99f73891fd7222ec0b4878c79d2ea1ab5ab Mon Sep 17 00:00:00 2001 From: Charlotte Vermandel Date: Tue, 20 Oct 2020 11:06:30 +0200 Subject: [PATCH 01/17] Prepare documentation for release 11/2020 of MeiliSearch --- .vuepress/config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vuepress/config.js b/.vuepress/config.js index 60c38cce7b..45453d76ef 100644 --- a/.vuepress/config.js +++ b/.vuepress/config.js @@ -1,6 +1,6 @@ const ogprefix = 'og: http://ogp.me/ns#' module.exports = { - title: 'MeiliSearch Documentation v0.18', + title: 'MeiliSearch Documentation v0.16', description: 'Open source Instant Search Engine', themeConfig: { repo: 'meilisearch/MeiliSearch', From baaa53cfa8245bb271ffa6560af85159d1a3b8ba Mon Sep 17 00:00:00 2001 From: Charlotte Vermandel Date: Tue, 27 Oct 2020 16:57:32 +0100 Subject: [PATCH 02/17] Change documents references --- references/documents.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/references/documents.md b/references/documents.md index 9d99d30cd0..3bb0a09b80 100644 --- a/references/documents.md +++ b/references/documents.md @@ -90,7 +90,7 @@ Documents are ordered by MeiliSearch depending on the hash of their id. -Add a list of [documents](/guides/main_concepts/documents.md) or replace them if they already exist. +Add a list of [documents](/guides/main_concepts/documents.md) or replace them if they already exist. If the provided index does not exist, it will be created. If you send an already existing document (same [id](/guides/main_concepts/documents.md#primary-key)) the **whole existing document** will be overwritten by the new document. Fields previously in the document not present in the new document are removed. @@ -146,7 +146,7 @@ This `updateId` allows you to [track the current update](/references/updates.md) -Add a list of documents and update them if they already. +Add a list of documents and update them if they already. If the provided index does not exist, it will be created. If you send an already existing document (same [id](/guides/main_concepts/documents.md#primary-key)) the old document will be only partially updated according to the fields of the new document. Thus, any fields not present in the new document are kept and remained unchanged. From 0b7e9cdf817fa3509b443df6b0af48ea2dcaedc3 Mon Sep 17 00:00:00 2001 From: Charlotte Vermandel Date: Tue, 27 Oct 2020 17:03:25 +0100 Subject: [PATCH 03/17] Add lazy index to indexes main concept --- guides/main_concepts/indexes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/guides/main_concepts/indexes.md b/guides/main_concepts/indexes.md index 7ec12a2ad3..a9bc342941 100644 --- a/guides/main_concepts/indexes.md +++ b/guides/main_concepts/indexes.md @@ -19,12 +19,12 @@ For example, it means you could create on the same server synonyms for a `movie` ## Index Creation -An index is created the first time documents are added to it or manually using the [create index endpoint](/references/indexes.md#create-an-index). +An Index is created the first time documents are added to it or manually using the [create index endpoint](/references/indexes.md#create-an-index). #### Example -Working on a fresh MeiliSearch instance with no indexes, let's add documents using the [add or replace documents endpoint](/references/documents.md#add-or-replace-documents). -We provide `movie` as our index name. Because there's currently no index of that name in our MeiliSearch instance, using the following code will: +In a new MeiliSearch instance without any index, let's add documents using the [add or replace documents endpoint](/references/documents.md#add-or-replace-documents). +We provide `movie` as our index. Because that index was not previously created, using the following code will: 1. Create the `movie` index. 2. Add the documents to it. From 5778327c11b09007e53208af8ba7a85af2577645 Mon Sep 17 00:00:00 2001 From: Charlotte Vermandel Date: Tue, 27 Oct 2020 17:05:43 +0100 Subject: [PATCH 04/17] Suggestion for lazy index into getting started --- guides/introduction/README.md | 1 - guides/introduction/quick_start_guide.md | 17 ++++------------- 2 files changed, 4 insertions(+), 14 deletions(-) diff --git a/guides/introduction/README.md b/guides/introduction/README.md index 983c398311..9c8a95d56f 100644 --- a/guides/introduction/README.md +++ b/guides/introduction/README.md @@ -6,7 +6,6 @@ Contents : - 🚀 Getting Started - [Download and launch MeiliSearch](/guides/introduction/quick_start_guide.md#download-and-launch) - - [Create your index](/guides/introduction/quick_start_guide.md#create-your-index) - [Add documents](/guides/introduction/quick_start_guide.md#add-documents) - [Search!](/guides/introduction/quick_start_guide.md#search) - 👩‍🚀 [What's next?](/guides/introduction/whats_next.md) diff --git a/guides/introduction/quick_start_guide.md b/guides/introduction/quick_start_guide.md index 65bb9c7aea..9f51757f02 100644 --- a/guides/introduction/quick_start_guide.md +++ b/guides/introduction/quick_start_guide.md @@ -22,20 +22,11 @@ Now that your MeiliSearch server is up and running, you should be able to commun Communication to the server is done through a [RESTful API](/references/README.md) or one of our [SDKs](/resources/sdks.md). -## Create your Index - -In MeiliSearch, the information is subdivided into indexes. Each [index](/guides/main_concepts/indexes.md) contains a data structure and associated documents. -Indexes can be comparable to SQL tables. Since MeiliSearch is , there's no need to define any attributes or data type when creating a table. - -In order to be able to store your documents in an index, it is required you create one first. - - - -[API references](/references/indexes.md) - ## Add Documents -Once the index has been created, the next step is to fill it with [documents](/guides/main_concepts/documents.md). These documents will be used and returned when search queries will be performed on MeiliSearch. +To add documents to MeiliSearch you need to provide an [index](/guides/main_concepts/indexes.md) name and [documents](/guides/main_concepts/documents.md). The documents will be stored inside the given `index`. The index is created the first time you add documents to it. + +The documents will be used and returned when search queries will be performed on MeiliSearch. Documents are represented in `JSON format`. @@ -43,7 +34,7 @@ To be processed, all documents must share one common that contains the string `id` in a case-insensitive manner. -Below is an example to showcase how to add documents using the following test dataset: [movies.json](https://github.com/meilisearch/MeiliSearch/blob/master/datasets/movies/movies.json). +Below is an example to showcase how to add documents to a index called `movies` using the following test dataset: [movies.json](https://github.com/meilisearch/MeiliSearch/blob/master/datasets/movies/movies.json). From 8e19ba07babd2f6d6dfa507a2e4adc4fd7fec5f8 Mon Sep 17 00:00:00 2001 From: Charlotte Vermandel Date: Wed, 28 Oct 2020 12:53:51 +0100 Subject: [PATCH 05/17] Fix type --- guides/introduction/quick_start_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/introduction/quick_start_guide.md b/guides/introduction/quick_start_guide.md index 9f51757f02..03db7c0675 100644 --- a/guides/introduction/quick_start_guide.md +++ b/guides/introduction/quick_start_guide.md @@ -34,7 +34,7 @@ To be processed, all documents must share one common that contains the string `id` in a case-insensitive manner. -Below is an example to showcase how to add documents to a index called `movies` using the following test dataset: [movies.json](https://github.com/meilisearch/MeiliSearch/blob/master/datasets/movies/movies.json). +Below is an example to showcase how to add documents to an index called `movies` using the following test dataset: [movies.json](https://github.com/meilisearch/MeiliSearch/blob/master/datasets/movies/movies.json). From 9ae5daab0ce6d6fbdb5cee428b61ad52f001cc6b Mon Sep 17 00:00:00 2001 From: cvermand <33010418+bidoubiwa@users.noreply.github.com> Date: Mon, 2 Nov 2020 09:45:45 +0100 Subject: [PATCH 06/17] Apply suggestions from code review Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com> --- guides/introduction/quick_start_guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/guides/introduction/quick_start_guide.md b/guides/introduction/quick_start_guide.md index 03db7c0675..c7421261a6 100644 --- a/guides/introduction/quick_start_guide.md +++ b/guides/introduction/quick_start_guide.md @@ -24,9 +24,9 @@ Communication to the server is done through a [RESTful API](/references/README.m ## Add Documents -To add documents to MeiliSearch you need to provide an [index](/guides/main_concepts/indexes.md) name and [documents](/guides/main_concepts/documents.md). The documents will be stored inside the given `index`. The index is created the first time you add documents to it. +To add documents to MeiliSearch you must provide [documents](/guides/main_concepts/documents.md) in the form of `JSON objects`, as well as a name for the [index](/guides/main_concepts/indexes.md) where they will be stored. If you try to add documents to an index that doesn't already exist, an index with the given name is automatically created. It is also possible to create indexes manually using the [create index endpoint](/references/indexes.md#create-an-index). -The documents will be used and returned when search queries will be performed on MeiliSearch. +Documents are the basic building blocks of your database. Whenever you perform a search query on an index, MeiliSearch examines the data contained in your documents and returns the ones that match your query, in order of [relevancy](/guides/main_concepts/relevancy.html). Documents are represented in `JSON format`. From c26fd2a437bbfcd2058e1fd716e2bc532ad6cd74 Mon Sep 17 00:00:00 2001 From: cvermand <33010418+bidoubiwa@users.noreply.github.com> Date: Mon, 2 Nov 2020 10:32:58 +0100 Subject: [PATCH 07/17] Update guides/introduction/quick_start_guide.md Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com> --- guides/introduction/quick_start_guide.md | 1 - 1 file changed, 1 deletion(-) diff --git a/guides/introduction/quick_start_guide.md b/guides/introduction/quick_start_guide.md index c7421261a6..3e248d627a 100644 --- a/guides/introduction/quick_start_guide.md +++ b/guides/introduction/quick_start_guide.md @@ -28,7 +28,6 @@ To add documents to MeiliSearch you must provide [documents](/guides/main_concep Documents are the basic building blocks of your database. Whenever you perform a search query on an index, MeiliSearch examines the data contained in your documents and returns the ones that match your query, in order of [relevancy](/guides/main_concepts/relevancy.html). -Documents are represented in `JSON format`. To be processed, all documents must share one common which will serve as [primary key](/guides/main_concepts/documents.md#primary-key) for the document. Values in that field must always be **unique**. From 4ec65600fd78df0ae469cc106e1124fb6c6a6257 Mon Sep 17 00:00:00 2001 From: cvermand <33010418+bidoubiwa@users.noreply.github.com> Date: Thu, 14 Jan 2021 18:17:19 +0100 Subject: [PATCH 08/17] Update .vuepress/config.js Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com> --- .vuepress/config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vuepress/config.js b/.vuepress/config.js index 45453d76ef..60c38cce7b 100644 --- a/.vuepress/config.js +++ b/.vuepress/config.js @@ -1,6 +1,6 @@ const ogprefix = 'og: http://ogp.me/ns#' module.exports = { - title: 'MeiliSearch Documentation v0.16', + title: 'MeiliSearch Documentation v0.18', description: 'Open source Instant Search Engine', themeConfig: { repo: 'meilisearch/MeiliSearch', From 767f950f55302cdb97fd6dabef2bd6ce3991f9a1 Mon Sep 17 00:00:00 2001 From: cvermand <33010418+bidoubiwa@users.noreply.github.com> Date: Thu, 14 Jan 2021 18:19:18 +0100 Subject: [PATCH 09/17] Update references/documents.md Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com> --- references/documents.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/references/documents.md b/references/documents.md index 3bb0a09b80..d8529d7af2 100644 --- a/references/documents.md +++ b/references/documents.md @@ -146,7 +146,7 @@ This `updateId` allows you to [track the current update](/references/updates.md) -Add a list of documents and update them if they already. If the provided index does not exist, it will be created. +Add a list of documents or update them if they already exist. If the provided index does not exist, it will be created. If you send an already existing document (same [id](/guides/main_concepts/documents.md#primary-key)) the old document will be only partially updated according to the fields of the new document. Thus, any fields not present in the new document are kept and remained unchanged. From 8b7a6024db1cfaa219193e5704e752e8e7e990f5 Mon Sep 17 00:00:00 2001 From: Charlotte Vermandel Date: Thu, 14 Jan 2021 18:30:34 +0100 Subject: [PATCH 10/17] Remove create index code sample --- .code-samples.meilisearch.yaml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index 85c6b097ff..dc0e6b0f65 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -365,14 +365,6 @@ search_guide_1: |- search_guide_2: |- $ curl 'http://localhost:7700/indexes/movies/search' \ --data '{ "q": "Avengers", "filters": "release_date > 795484800" }' -getting_started_create_index_md: |- - ```bash - $ curl \ - -X POST 'http://127.0.0.1:7700/indexes' \ - --data '{ - "uid" : "movies" - }' - ``` getting_started_add_documents_md: |- ```bash $ curl \ From a932baa0e97626c0c34fa84361c4c3107b54315f Mon Sep 17 00:00:00 2001 From: cvermand <33010418+bidoubiwa@users.noreply.github.com> Date: Sat, 16 Jan 2021 16:41:08 +0100 Subject: [PATCH 11/17] Update guides/introduction/quick_start_guide.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Clémentine Urquizar --- guides/introduction/quick_start_guide.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/guides/introduction/quick_start_guide.md b/guides/introduction/quick_start_guide.md index 3e248d627a..624d56ea12 100644 --- a/guides/introduction/quick_start_guide.md +++ b/guides/introduction/quick_start_guide.md @@ -24,9 +24,10 @@ Communication to the server is done through a [RESTful API](/references/README.m ## Add Documents -To add documents to MeiliSearch you must provide [documents](/guides/main_concepts/documents.md) in the form of `JSON objects`, as well as a name for the [index](/guides/main_concepts/indexes.md) where they will be stored. If you try to add documents to an index that doesn't already exist, an index with the given name is automatically created. It is also possible to create indexes manually using the [create index endpoint](/references/indexes.md#create-an-index). - -Documents are the basic building blocks of your database. Whenever you perform a search query on an index, MeiliSearch examines the data contained in your documents and returns the ones that match your query, in order of [relevancy](/guides/main_concepts/relevancy.html). +To add documents to MeiliSearch you must provide: +- [documents](/guides/main_concepts/documents.md) in the form of `JSON objects` +- the name for the [index](/guides/main_concepts/indexes.md). An index is where the documents will be stored. +If you try to add documents to an index that doesn't already exist, an index with the given name is automatically created. To be processed, all documents must share one common which will serve as [primary key](/guides/main_concepts/documents.md#primary-key) for the document. Values in that field must always be **unique**. From f1374efa413e46ce551f9005c4d6e0033eb1b011 Mon Sep 17 00:00:00 2001 From: cvermand <33010418+bidoubiwa@users.noreply.github.com> Date: Sat, 16 Jan 2021 16:41:18 +0100 Subject: [PATCH 12/17] Update guides/main_concepts/indexes.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Clémentine Urquizar --- guides/main_concepts/indexes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/main_concepts/indexes.md b/guides/main_concepts/indexes.md index a9bc342941..f2f6a52c57 100644 --- a/guides/main_concepts/indexes.md +++ b/guides/main_concepts/indexes.md @@ -19,7 +19,7 @@ For example, it means you could create on the same server synonyms for a `movie` ## Index Creation -An Index is created the first time documents are added to it or manually using the [create index endpoint](/references/indexes.md#create-an-index). +An index is created the first time documents are added to it or manually using the [create index endpoint](/references/indexes.md#create-an-index). #### Example From fb571baf6303f46cc4234c8f7b979f45b971a6a4 Mon Sep 17 00:00:00 2001 From: cvermand <33010418+bidoubiwa@users.noreply.github.com> Date: Sat, 16 Jan 2021 16:41:26 +0100 Subject: [PATCH 13/17] Update guides/main_concepts/indexes.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Clémentine Urquizar --- guides/main_concepts/indexes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/main_concepts/indexes.md b/guides/main_concepts/indexes.md index f2f6a52c57..3b31013cb4 100644 --- a/guides/main_concepts/indexes.md +++ b/guides/main_concepts/indexes.md @@ -24,7 +24,7 @@ An index is created the first time documents are added to it or manually using t #### Example In a new MeiliSearch instance without any index, let's add documents using the [add or replace documents endpoint](/references/documents.md#add-or-replace-documents). -We provide `movie` as our index. Because that index was not previously created, using the following code will: +We provide `movies` as our index. Because that index was not previously created, using the following code will: 1. Create the `movie` index. 2. Add the documents to it. From 927c0392cf0977cb445c1e2ec9ac3b96d3e569dd Mon Sep 17 00:00:00 2001 From: Charlotte Vermandel Date: Sat, 16 Jan 2021 17:10:22 +0100 Subject: [PATCH 14/17] Update documents addition in getting started. Updated primary key definition --- .vuepress/components/glossary.vue | 2 +- guides/introduction/quick_start_guide.md | 18 ++++++++++++++---- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/.vuepress/components/glossary.vue b/.vuepress/components/glossary.vue index 75289a0727..7d6929a9c0 100644 --- a/.vuepress/components/glossary.vue +++ b/.vuepress/components/glossary.vue @@ -26,7 +26,7 @@ const glossary = { 'primary field': 'A special field containing the primary key and a unique document id.

Every document must possess a correctly formatted primary field in order to be indexed.', 'primary key': - 'The attribute of the primary field. The primary key\'s associated value is a unique document id. An index possesses only one primary key, which is shared among all its documents.

Example: in a document with the primary field "movie_id": "Abc_012", "movie_id" is the primary key.', + 'The attribute name of the field with an unique value in each document.

Example: In a document with the primary field "id": "Abc_012", "id" is the primary key and "Abc_012" the unique identifier.

The unique value is used to recognize documents in MeiliSearch. An index only needs one primary key.', 'document id': 'The value of the primary field. The document id acts as a unique identifier for storing documents.

Example: in a document with the primary field "movie_id": "Abc_012", "Abc_012" is the document id.', schemaless: diff --git a/guides/introduction/quick_start_guide.md b/guides/introduction/quick_start_guide.md index 624d56ea12..e7047875dc 100644 --- a/guides/introduction/quick_start_guide.md +++ b/guides/introduction/quick_start_guide.md @@ -25,12 +25,20 @@ Communication to the server is done through a [RESTful API](/references/README.m ## Add Documents To add documents to MeiliSearch you must provide: -- [documents](/guides/main_concepts/documents.md) in the form of `JSON objects` -- the name for the [index](/guides/main_concepts/indexes.md). An index is where the documents will be stored. -If you try to add documents to an index that doesn't already exist, an index with the given name is automatically created. +- [Documents](/guides/main_concepts/documents.md) in the form of `JSON objects`. +- An [index](/guides/main_concepts/indexes.md) name (_uid_). An index is where the documents are stored. +> _If the index does not exist, MeiliSearch creates it when you first add the documents._ -To be processed, all documents must share one common which will serve as [primary key](/guides/main_concepts/documents.md#primary-key) for the document. Values in that field must always be **unique**. +To be processed, all documents must share one common which will serve as [](/guides/main_concepts/documents.md#primary-key) for the document. Values in that field must always be **unique**. + +```json +{ + "id": "123", + "title": "Superman" +} +``` +> The primary key is `id`, the document's unique identifier is `123`. There are [several ways to let MeiliSearch know what the primary key](/guides/main_concepts/documents.md#primary-key) is. The easiest one is to have an that contains the string `id` in a case-insensitive manner. @@ -52,6 +60,8 @@ You can check the status of the operation via the `updateId` and the [get update Checking the update status is not a mandatory step to search through your documents but could prove useful in tracing the origin of errors or unexpected behaviors. +[API references](/references/updates.md) + ## Search Now that your documents have been ingested into MeiliSearch, you are able to [search them](/guides/main_concepts/search.md). From 40b2c7b7328a216165f9ec439b03a480a9754acd Mon Sep 17 00:00:00 2001 From: cvermand <33010418+bidoubiwa@users.noreply.github.com> Date: Mon, 18 Jan 2021 19:15:22 +0100 Subject: [PATCH 15/17] Update .vuepress/components/glossary.vue Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com> --- .vuepress/components/glossary.vue | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vuepress/components/glossary.vue b/.vuepress/components/glossary.vue index 7d6929a9c0..40f0b2d8eb 100644 --- a/.vuepress/components/glossary.vue +++ b/.vuepress/components/glossary.vue @@ -26,7 +26,7 @@ const glossary = { 'primary field': 'A special field containing the primary key and a unique document id.

Every document must possess a correctly formatted primary field in order to be indexed.', 'primary key': - 'The attribute name of the field with an unique value in each document.

Example: In a document with the primary field "id": "Abc_012", "id" is the primary key and "Abc_012" the unique identifier.

The unique value is used to recognize documents in MeiliSearch. An index only needs one primary key.', + 'An attribute that must be present in every document of a given index, used to identify and distinguish documents.

Example: In a document with the primary field "id": "Abc_012", "id" is the index's primary key and "Abc_012" is the document's unique identifier.', 'document id': 'The value of the primary field. The document id acts as a unique identifier for storing documents.

Example: in a document with the primary field "movie_id": "Abc_012", "Abc_012" is the document id.', schemaless: From ba007006f43348c6b44821d7b6e52868fbd341f6 Mon Sep 17 00:00:00 2001 From: cvermand <33010418+bidoubiwa@users.noreply.github.com> Date: Mon, 18 Jan 2021 19:15:32 +0100 Subject: [PATCH 16/17] Update guides/introduction/quick_start_guide.md Co-authored-by: Tommy <68053732+react-learner@users.noreply.github.com> --- guides/introduction/quick_start_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/introduction/quick_start_guide.md b/guides/introduction/quick_start_guide.md index e7047875dc..5871e706a8 100644 --- a/guides/introduction/quick_start_guide.md +++ b/guides/introduction/quick_start_guide.md @@ -28,7 +28,7 @@ To add documents to MeiliSearch you must provide: - [Documents](/guides/main_concepts/documents.md) in the form of `JSON objects`. - An [index](/guides/main_concepts/indexes.md) name (_uid_). An index is where the documents are stored. -> _If the index does not exist, MeiliSearch creates it when you first add the documents._ +> _If the index does not exist, MeiliSearch creates it when you first add documents._ To be processed, all documents must share one common which will serve as [](/guides/main_concepts/documents.md#primary-key) for the document. Values in that field must always be **unique**. From 6b59d789da23f5b0388247499056820a3c34e9f1 Mon Sep 17 00:00:00 2001 From: Charlotte Vermandel Date: Mon, 18 Jan 2021 19:20:35 +0100 Subject: [PATCH 17/17] Fix styling --- .vuepress/components/glossary.vue | 2 +- guides/introduction/quick_start_guide.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.vuepress/components/glossary.vue b/.vuepress/components/glossary.vue index 40f0b2d8eb..7716d47f1d 100644 --- a/.vuepress/components/glossary.vue +++ b/.vuepress/components/glossary.vue @@ -26,7 +26,7 @@ const glossary = { 'primary field': 'A special field containing the primary key and a unique document id.

Every document must possess a correctly formatted primary field in order to be indexed.', 'primary key': - 'An attribute that must be present in every document of a given index, used to identify and distinguish documents.

Example: In a document with the primary field "id": "Abc_012", "id" is the index's primary key and "Abc_012" is the document's unique identifier.', + 'An attribute that must be present in every document of a given index, used to identify and distinguish documents.

Example: In a document with the primary field "id": "Abc_012", "id" is the index\'s primary key and "Abc_012" is the document\'s unique identifier.', 'document id': 'The value of the primary field. The document id acts as a unique identifier for storing documents.

Example: in a document with the primary field "movie_id": "Abc_012", "Abc_012" is the document id.', schemaless: diff --git a/guides/introduction/quick_start_guide.md b/guides/introduction/quick_start_guide.md index 5871e706a8..f9a522f4a2 100644 --- a/guides/introduction/quick_start_guide.md +++ b/guides/introduction/quick_start_guide.md @@ -25,6 +25,7 @@ Communication to the server is done through a [RESTful API](/references/README.m ## Add Documents To add documents to MeiliSearch you must provide: + - [Documents](/guides/main_concepts/documents.md) in the form of `JSON objects`. - An [index](/guides/main_concepts/indexes.md) name (_uid_). An index is where the documents are stored. @@ -38,6 +39,7 @@ To be processed, all documents must share one common The primary key is `id`, the document's unique identifier is `123`. There are [several ways to let MeiliSearch know what the primary key](/guides/main_concepts/documents.md#primary-key) is. The easiest one is to have an that contains the string `id` in a case-insensitive manner.