Skip to content

Commit 1a29447

Browse files
bors[bot]maryamsulemani97dichotommy
authored
Merge #2058
2058: update `updating.md` r=maryamsulemani97 a=maryamsulemani97 closes #1849 and #1583 - This is a three-step guide with sub-headings for the other steps - Added a heading on "version-specific instructions" at the beginning of the guide - Used bold for cloud platforms to help it stand out - For this version of the guide, old versions will only have curl code samples <hr> - Update code samples to use `X-Meili-API-Key: API_KEY` for v0.24 and below - Update the "Set all fields as displayed attributes" step to - use `updateId` instead of `taskUid` - use `processed` instead of `succeeded` - Use {} for dumpfile in the "create dump" step - Update note to mention v1 - add content for updating Meilisearch on cloud platforms - add tabs for local installation and cloud platforms for code samples - update code samples to use `<your-domain-name>` instead of `local host` Co-authored-by: Maryam Sulemani <[email protected]> Co-authored-by: Maryam <[email protected]> Co-authored-by: maryamsulemani97 <[email protected]> Co-authored-by: Tommy <[email protected]>
2 parents b3ed639 + 2d1706d commit 1a29447

File tree

4 files changed

+257
-137
lines changed

4 files changed

+257
-137
lines changed

.code-samples.meilisearch.yaml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -841,25 +841,26 @@ typo_tolerance_guide_4: |-
841841
}'
842842
updating_guide_check_version_new_authorization_header: |-
843843
curl \
844-
-X GET 'http://localhost:7700/version' \
844+
-X GET 'http://<your-domain-name>/version' \
845845
-H 'Authorization: Bearer API_KEY'
846846
updating_guide_check_version_old_authorization_header: |-
847847
curl \
848-
-X GET 'http://localhost:7700/version' \
848+
-X GET 'http://<your-domain-name>/version' \
849849
-H 'X-Meili-API-Key: API_KEY'
850-
updating_guide_get_displayed_attributes_new: |-
850+
updating_guide_get_displayed_attributes_old_authorization_header: |-
851851
# whenever you see {index_uid}, replace it with your index's unique id
852852
curl \
853-
-X GET 'http://localhost:7700/indexes/{index_uid}/settings/displayed-attributes' \
854-
-H 'Authorization: Bearer API_KEY'
855-
updating_guide_reset_displayed_attributes_new: |-
853+
-X GET 'http://<your-domain-name>/indexes/{index_uid}/settings/displayed-attributes' \
854+
-H 'X-Meili-API-Key: API_KEY'
855+
updating_guide_reset_displayed_attributes_old_authorization_header: |-
856856
curl \
857-
-X DELETE 'http://localhost:7700/indexes/{index_uid}/settings/displayed-attributes' \
858-
-H 'Authorization: Bearer API_KEY'
857+
-X DELETE 'http://<your-domain-name>/indexes/{index_uid}/settings/displayed-attributes' \
858+
-H 'X-Meili-API-Key: API_KEY'
859859
updating_guide_create_dump: |-
860860
curl \
861-
-X POST 'http://localhost:7700/dumps' \
861+
-X POST 'http://<your-domain-name>/dumps' \
862862
-H 'Authorization: Bearer API_KEY'
863+
# -H 'X-Meili-API-Key: API_KEY' for v0.24 or below
863864
getting_started_typo_tolerance: |-
864865
curl \
865866
-X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \

.vuepress/public/sample-template.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ typo_tolerance_guide_3: |-
130130
typo_tolerance_guide_4: |-
131131
updating_guide_check_version_new_authorization_header: |-
132132
updating_guide_check_version_old_authorization_header: |-
133-
updating_guide_get_displayed_attributes_new: |-
134-
updating_guide_reset_displayed_attributes_new: |-
133+
updating_guide_get_displayed_attributes_old_authorization_header: |-
134+
updating_guide_reset_displayed_attributes_old_authorization_header: |-
135135
updating_guide_create_dump: |-
136136
getting_started_typo_tolerance: |-
137137
get_pagination_settings_1: |-

learn/advanced/geosearch.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Meilisearch allows you to filter and sort results based on their geographic location. This can be useful when you only want results within a specific area or when sorting results based on their distance from a specific location.
44

5+
::: danger `_geo` field in v0.27, v0.28, and v0.29
6+
Due to Meilisearch allowing malformed `_geo` fields in the above-mentioned versions, please ensure the `_geo` field follows the correct format.
7+
:::
8+
59
## Preparing documents for location-based search
610

711
In order to start filtering and sorting documents based on their geographic location, you must make sure they contain a valid `_geo` field.

0 commit comments

Comments
 (0)