Merge branch 'master' into update-docments.md

Author: maryamsulemani97

.code-samples.meilisearch.yaml

@@ -387,8 +387,8 @@ search_parameter_guide_highlight_tag_1: |-
   curl \
     -X POST 'http://localhost:7700/indexes/movies/search' \
     -H 'Content-Type: application/json' \
-    --data-binary '{ 
-      "q": "winter feast", 
+    --data-binary '{
+      "q": "winter feast",
       "attributesToHighlight": ["overview"],
       "highlightPreTag": "<span class=\"highlight\">",
       "highlightPostTag": "</span>"
@@ -770,7 +770,7 @@ primary_field_guide_add_document_primary_key: |-
         "genres": ["comedy","humor"],
         "price": 5.00
      }]'
-primary_field_guide_update_document_primary_key: |
+primary_field_guide_update_document_primary_key: |-
   curl \
     -X PUT 'http://localhost:7700/indexes/books' \
     -H 'Content-Type: application/json' \
@@ -806,7 +806,7 @@ typo_tolerance_guide_1: |-
     -H 'Content-Type: application/json' \
     --data-binary '{
       "enabled": false
-    }'    
+    }'
 typo_tolerance_guide_2: |-
   curl \
     -X POST 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
@@ -847,10 +847,14 @@ settings_guide_typo_tolerance_1: |-
           "title"
         ]
       }'
-updating_guide_check_version: |-
+updating_guide_check_version_new_authorization_header: |-
   curl \
-    -X GET 'http://127.0.0.1:7700/version' \
-    -H 'Authorization: Bearer apiKey'
+      -X GET 'http://127.0.0.1:7700/version' \
+      -H 'Authorization: Bearer apiKey'
+updating_guide_check_version_old_authorization_header: |-
+  curl \
+      -X GET 'http://127.0.0.1:7700/version' \
+      -H 'X-Meili-API-Key: apiKey'    
 updating_guide_get_displayed_attributes_new: |-
   # whenever you see {index_uid}, replace it with your index's unique id
   curl \
@@ -860,15 +864,15 @@ updating_guide_get_displayed_attributes_old: |-
   # whenever you see {index_uid}, replace it with your index's unique id
   curl \
     -X GET 'http://127.0.0.1:7700/indexes/{index_uid}/settings/displayed-attributes' \
-    -H 'X-Meili-API-Key: apiKey'    
+    -H 'X-Meili-API-Key: apiKey'
 updating_guide_reset_displayed_attributes_new: |-
   curl \
     -X DELETE 'http://127.0.0.1:7700/indexes/{index_uid}/settings/displayed-attributes' \
     -H 'Authorization: Bearer apiKey'
 updating_guide_reset_displayed_attributes_old: |-
   curl \
     -X DELETE 'http://127.0.0.1:7700/indexes/{index_uid}/settings/displayed-attributes' \
-    -H 'X-Meili-API-Key: apiKey'  
+    -H 'X-Meili-API-Key: apiKey'
 updating_guide_create_dump: |-
   curl \
     -X POST 'http://127.0.0.1:7700/dumps' \
@@ -878,26 +882,25 @@ updating_guide_get_dump_status: |-
   curl \
     -X GET 'http://127.0.0.1:7700/dumps/{dump_uid}/status' \
     -H 'Authorization: Bearer apiKey'
-updating_guide_get_settings: |-
+updating_guide_get_settings_old: |-
   # the -o option saves the output as a local file
   curl \
     -X GET 'http://127.0.0.1:7700/indexes/{index_uid}/settings' -o mysettings.json \
     -H 'X-Meili-API-Key: apiKey'
-updating_guide_retrieve_documents: |-
+updating_guide_retrieve_documents_old: |-
   # the -o option saves the output as a local file
   curl \
-    -X GET 'http://127.0.0.1:7700/indexes/{index_uid}/documents?limit=n' \ -o mydocuments.json \ 
+    -X GET 'http://127.0.0.1:7700/indexes/{index_uid}/documents?limit=n' \ -o mydocuments.json \
     -H 'X-Meili-API-Key: apiKey'
-updating_guide_update_settings: |-
+updating_guide_update_settings_old: |-
   # update your settings
   curl \
     -X POST 'http://127.0.0.1:7700/indexes/{index_uid}/settings' \
     -H 'Content-Type: application/json' -d @mysettings.json \
     -H 'X-Meili-API-Key: apiKey'
-updating_guide_add_documents: |-
+updating_guide_add_documents_old: |-
   # then, add your documents
   curl \
     -X POST 'http://127.0.0.1:7700/indexes/{index_uid}/documents' \
     -H 'Content-Type: application/json' -d @mydocuments.json \
     -H 'X-Meili-API-Key: apiKey'
- 

.vuepress/config-path-checker/README.md

@@ -4,9 +4,9 @@ This local plugin checks inside the routing of `config.js` every chosen predicat
 
 These are the current predicates:
 
-### Parent's paths must contains a trailing html extension
+### Parent's paths must contains a trailing HTML extension
 
-This predicate only applies to elements that do have childs.
+This predicate only applies to elements that have children.
 
 For example:
 

.vuepress/public/getting-started/default_displayed_attributes.png

@@ -133,14 +133,15 @@ typo_tolerance_guide_2: |-
 typo_tolerance_guide_3: |-
 typo_tolerance_guide_4: |-
 settings_guide_typo_tolerance_1: |-
-updating_guide_check_version: |-
+updating_guide_check_version_new_authorization_header: |-
+updating_guide_check_version_old_authorization_header: |-
 updating_guide_get_displayed_attributes_new: |-
 updating_guide_get_displayed_attributes_old: |-
 updating_guide_reset_displayed_attributes_old: |-
 updating_guide_reset_displayed_attributes_new: |-
 updating_guide_create_dump: |-
 updating_guide_get_dump_status: |-
-updating_guide_get_settings: |-
-updating_guide_retrieve_documents: |-
-updating_guide_update_settings: |-
-updating_guide_add_documents: |-
+updating_guide_get_settings_old: |-
+updating_guide_retrieve_documents_old: |-
+updating_guide_update_settings_old: |-
+updating_guide_add_documents_old: |-

.vuepress/public/getting-started/default_searchableAttributes.gif

@@ -27,7 +27,7 @@ Suppose you have a collection of movies containing the following fields:
 ```json
 [
   {
-    "id": "458723",
+    "id": 458723,
     "title": "Us",
     "director": "Jordan Peele",
     "genres": [
@@ -167,7 +167,7 @@ Suppose that you have a dataset containing several movies in the following forma
 [
   …
   {
-    "id": "458723",
+    "id": 458723,
     "title": "Us",
     "director": "Jordan Peele",
     "poster": "https://image.tmdb.org/t/p/w1280/ux2dU1jQ2ACIMShzB3yP93Udpzc.jpg",

.vuepress/public/getting-started/multiple_indexes.png

@@ -1,4 +1,4 @@
-# Data backup: snapshots vs. dumps
+# Data backup: Snapshots vs dumps
 
 Meilisearch has two ways to backup its data: `snapshots` and `dumps`.
 

.vuepress/public/getting-started/title_searchableAttributes.gif

@@ -18,7 +18,12 @@ Before we begin, you need to **verify the version of Meilisearch that's compatib
 
 If Meilisearch launches successfully, use the [get version endpoint](/reference/api/version.md), note your `pkgVersion`, and [proceed to the next step](#proceed-according-to-your-database-version).
 
-<CodeSamples id="updating_guide_check_version" />
+<CodeSamples id="updating_guide_check_version_new_authorization_header" />
+
+::: note
+ If you're using v0.24 or below, use the `X-MEILI-API-KEY: apiKey` authorization header:
+ <CodeSamples id="updating_guide_check_version_old_authorization_header" />
+:::
 
 The response should look something like this:
 
@@ -269,7 +274,7 @@ If you don’t need to preserve index settings, skip directly to [step two](#ste
 
 First, use the [get settings endpoint](/reference/api/settings.md#get-settings) to retrieve the [settings](/learn/configuration/settings.md) of any indexes you want to preserve, and save them to a file using the method you prefer.
 
-<CodeSamples id="updating_guide_get_settings" />
+<CodeSamples id="updating_guide_get_settings_old" />
 
 Repeat this process for all indexes you wish to migrate.
 
@@ -297,7 +302,7 @@ Now that all fields are displayed, proceed to the next step.
 
 Use the [get documents endpoint](/reference/api/documents.md#get-documents) to retrieve your documents and save them using the method you prefer. Make sure to set the `limit` on documents returned so that, if you have some number of documents `n`, `limit ≥ n`. Otherwise, you risk data loss.
 
-<CodeSamples id="updating_guide_retrieve_documents" />
+<CodeSamples id="updating_guide_retrieve_documents_old" />
 
 ### Step 4: Delete the database folder
 
@@ -309,9 +314,9 @@ Finally, [install the latest version of Meilisearch](/learn/getting_started/quic
 
 If you chose to save your settings, make sure to follow this order:
 
-<CodeSamples id="updating_guide_update_settings" />
+<CodeSamples id="updating_guide_update_settings_old" />
 
-<CodeSamples id="updating_guide_add_documents" />
+<CodeSamples id="updating_guide_add_documents_old" />
 
 Since updating the settings requires re-indexing all documents, this order saves time and memory.
 

.vuepress/public/getting-started/updated_displayed_attributes.png

@@ -7,7 +7,7 @@ This page describes the **index-level settings** available in Meilisearch and ho
 | **[displayedAttributes](/learn/configuration/settings.md#displayed-attributes)**   | Fields displayed in the returned documents                                       | All attributes found in the documents                                                       |
 | **[distinctAttribute](/learn/configuration/settings.md#distinct-attribute)**       | Search returns documents with distinct (different) values of the given field     | `null`                                                                                      |
 | **[filterableAttributes](/learn/configuration/settings.md#filterable-attributes)** | List of attributes that can be used for filtering                                | `null`                                                                                      |
-| **[rankingRules](/learn/configuration/settings.md#ranking-rules)**                 | List of ranking rules sorted by order of importance                              | [A list of ordered built-in ranking rules](/learn/core_concepts/relevancy.md#default-order) |
+| **[rankingRules](/learn/configuration/settings.md#ranking-rules)**                 | List of ranking rules sorted by order of importance                              | [A list of ordered built-in ranking rules](/learn/core_concepts/relevancy.md#built-in-rules) |
 | **[searchableAttributes](/learn/configuration/settings.md#searchable-attributes)** | Fields in which to search for matching query words sorted by order of importance | All attributes found in the documents                                                       |                                                     |
 | **[sortableAttributes](/learn/configuration/settings.md#sortable-attributes)**     |  List of attributes to use when sorting search results                           | `[]`                                                                         |
 | **[stopWords](/learn/configuration/settings.md#stop-words)**                       | List of words ignored by Meilisearch when present in search queries              | `[]`                                                                                        |

.vuepress/public/getting-started/web_interface_without_documents.png

@@ -11,7 +11,7 @@ All synonyms are **lowercased** and **de-unicoded** during the indexing process.
 
 #### Example
 
-Consider a situation where "Résumé" and "CV" are set as synonyms.
+Consider a situation where `Résumé` and `CV` are set as synonyms.
 
 ```json
 {
@@ -24,7 +24,7 @@ Consider a situation where "Résumé" and "CV" are set as synonyms.
 }
 ```
 
-A search for "cv" would return any documents containing "cv" or "CV", in addition to any that contain "Résumé", "resumé", "resume", etc. unaffected by case or accent marks.
+A search for `cv` would return any documents containing `cv` or `CV`, in addition to any that contain `Résumé`, `resumé`, `resume`, etc., unaffected by case or accent marks.
 
 ## One-way association
 
@@ -97,12 +97,12 @@ When a multi-word phrase is considered the synonym of another word or phrase, th
 
 ::: tip
 Multi-word synonyms are limited to a maximum of **three words**.
-For example, although you could make "League of Legends" and "LOL" into synonyms, you could not do the same for "The Lord of the Rings" and "LOTR".
+For example, although you could make `League of Legends` and `LOL` into synonyms, you could not do the same for `The Lord of the Rings` and `LOTR`.
 :::
 
 #### Example
 
-Suppose you set "San Francisco" and "SF" as synonyms with a [mutual association](#mutual-association)
+Suppose you set `San Francisco` and `SF` as synonyms with a [mutual association](#mutual-association)
 
 ```json
 {
@@ -115,4 +115,4 @@ Suppose you set "San Francisco" and "SF" as synonyms with a [mutual association]
 }
 ```
 
-If you input "SF" as a search query, then results containing "San Francisco" will also be returned. However, **they will be considered less [relevant](/learn/core_concepts/relevancy.md) than those containing "SF"**. The reverse is also true.
+If you input `SF` as a search query, then results containing `San Francisco` will also be returned. However, **they will be considered less [relevant](/learn/core_concepts/relevancy.md) than those containing `SF`**. The reverse is also true.

.vuepress/public/movies.json

@@ -34,7 +34,7 @@ We recommend keeping the value of `oneTypo` between `2` and `8` and the value of
 Meilisearch considers a typo on a query's first character as two typos.
 
 **Concatenation**
-When considering possible candidates for typo tolerance, Meilisearch will concatenate multiple search terms separated by a [space separator](/learn/advanced/datatypes.md#string). This is treated as one typo. For example, a search for "any way" would match documents containing "anyway".
+When considering possible candidates for typo tolerance, Meilisearch will concatenate multiple search terms separated by a [space separator](/learn/advanced/datatypes.md#string). This is treated as one typo. For example, a search for `any way` would match documents containing `anyway`.
 
 For more about typo calculations, [see below](#understanding-typo-calculations).
 :::
@@ -77,19 +77,19 @@ Meilisearch uses a prefix [Levenshtein algorithm](https://en.wikipedia.org/wiki/
 
 The [number of typos referenced above](#minwordsizefortypos) is roughly equivalent to Levenshtein distance. The Levenshtein distance between two words _M_ and _P_ can be thought of as "the minimum cost of transforming _M_ into _P_" by performing the following elementary operations on _M_:
 
-- substitution of a character (e.g., **k**itten → **s**itten)
-- insertion of a character (e.g., siting → sit**t**ing)
-- deletion of a character (e.g., satu**r**day → satuday)
+- substitution of a character (e.g., `kitten` → `sitten`)
+- insertion of a character (e.g., `siting` → `sitting`)
+- deletion of a character (e.g., `saturday` → `satuday`)
 
 By default, Meilisearch uses the following rules for matching documents. Note that these rules are **by word** and not for the whole query string.
 
 - If the query word is between `1` and `4` characters, **no typo** is allowed. Only documents that contain words that **start with** or are of the **same length** with this query word are considered valid
 - If the query word is between `5` and `8` characters, **one typo** is allowed. Documents that contain words that match with **one typo** are retained for the next steps.
 - If the query word contains more than `8` characters, we accept a maximum of **two typos**
 
-This means that "saturday" which is `7` characters long, uses the second rule and matches every document containing **one typo**. For example:
+This means that `saturday` which is `7` characters long, uses the second rule and matches every document containing **one typo**. For example:
 
-- "saturday" is accepted because it is the same word
-- "satuday" is accepted because it contains **one typo**
-- "sutuday" is not accepted because it contains **two typos**
-- "caturday" is not accepted because it contains **two typos** (as explained [above](#minwordsizefortypos), a typo on the first letter of a word is treated as two typos)
+- `saturday` is accepted because it is the same word
+- `satuday` is accepted because it contains **one typo**
+- `sutuday` is not accepted because it contains **two typos**
+- `caturday` is not accepted because it contains **two typos** (as explained [above](#minwordsizefortypos), a typo on the first letter of a word is treated as two typos)

.vuepress/public/sample-template.yaml

@@ -23,7 +23,7 @@ In the top-right corner, click on the **Launch instances** button to start the p
 
 You will now select which AMI or system Image to use to run your instance. Type **"meilisearch"** in the search bar and select the **Community AMIs** tab on the left sidebar.
 
-![Page titled: 'Step 1: Choose an Amazon Machine Image (AMI)'. There is only one AMI available, MeiliSearch-v0.19.0-Debian-10.3](/aws/02.select-ami.png)
+![Page titled: 'Step 1: Choose an Amazon Machine Image (AMI)'](/aws/02.select-ami.png)
 
 Click on **Select** (right side of the screen) to confirm your choice.
 

.vuepress/public/search_preview.png

@@ -65,7 +65,7 @@ Meilisearch has snapshot and dump features that can help improve your backup cap
 
 ### Always-on
 
-To enable free tier, the _Always-on_ option is disabled by default. That means that after some time without any traffic, your instance will be deallocated. When the next client hits your instance, it'll be started again automatically. However, you will have a response time in the dozen-seconds range.
+To enable free tier, the _Always-on_ option is disabled by default. That means that after some time without any traffic, your instance will be deactivated. When the next client hits your instance, it'll be started again automatically. However, you will have a response time in the dozen-seconds range.
 
 You can avoid this _cold start_ by enabling the _Always-on_ feature, either in the Azure portal or in the Infrastructure as Code.
 

.vuepress/public/search_preview/default.png

@@ -25,7 +25,7 @@ python -c 'import os,base64; print(base64.urlsafe_b64encode(os.urandom(32)).deco
 ```
 
 ::: warning
-Setting up a master key is optional but strongly recommended when running in production. Unsetting the master key will make your Meilisearch instance unprotected and publicly accessible.
+Using a master key is optional but strongly recommended when running in production. If you launch without a master key, your Meilisearch instance will be unprotected and publicly accessible.
 :::
 
 ### Test Meilisearch

.vuepress/public/search_preview/multiple_indexes.png

@@ -70,7 +70,7 @@ As an example, let's say you are creating an index that contains information abo
 
 ```json
 {
-  "id": "1564saqw12ss",
+  "id": 1564,
   "title": "Kung Fu Panda",
   "genres": "Children's Animation",
   "release-year": 2008,
@@ -98,7 +98,7 @@ Compared to JSON, NDJSON has better writing performance and is less CPU and memo
 The above JSON document would look like this in NDJSON:
 
 ```json
-{ "id": "1564saqw12ss", "title": "Kung Fu Panda", "genres": "Children's Animation", "release-year": 2008, "cast": [{ "Jack Black": "Po" }, { "Jackie Chan": "Monkey" }] }
+{ "id": 1564, "title": "Kung Fu Panda", "genres": "Children's Animation", "release-year": 2008, "cast": [{ "Jack Black": "Po" }, { "Jackie Chan": "Monkey" }] }
 ```
 
 #### CSV
@@ -112,8 +112,8 @@ Compared to JSON, CSV has better writing performance and is less CPU and memory
 The above JSON document would look like this in CSV:
 
 ```csv
-  "id:string","title:string","genres:string","release-year:number"
-  "1564saqw12ss","Kung Fu Panda","Children's Animation","2008"
+  "id:number","title:string","genres:string","release-year:number"
+  "1564","Kung Fu Panda","Children's Animation","2008"
 ```
 
 Since CSV does not support arrays or nested objects, `cast` cannot be converted to CSV.