Skip to content

Commit deb4fe5

Browse files
Merge #2043 #2044
2043: comparison of implicit vs. explicit index creation r=maryamsulemani97 a=maryamsulemani97 closes #873 2044: Remove`learn/configuration/settings.md` r=maryamsulemani97 a=maryamsulemani97 closes #1614 ## Update - We decided to go with 3 ## What is this PR doing? - Removes all unused code samples - Updates links from `/learn/configuration/settings.md` to API reference - Uses the same table in the API reference and `/learn/configuration/settings.md` - Adds "developer-friendly syntax" to the "Body" of each setting in the API reference ~- Moves "developer-friendly syntax"(`displayedAttributes=[<String>, <String>, ...]`) to a new column "Format" in the table in `/learn/configuration/settings.md`~ ~- I don't like how the table looks because of the "Format" column, and "Type" and "Format" are talking about the same thing:~ ~- Should we remove "Type"? I think it's a lot easier to process compared to "Format"~ ~- Orrr we could have the same table as the[ API reference](https://docs.meilisearch.com/reference/api/settings.html#body)? It will be easier to update too. Update one table and copy it to the other~ ~WDYT `@guimachiavelli` `@dichotommy?~` <hr> 1. We get rid of `/learn/configuration/settings.md` ![Screen Shot 2022-12-13 at 15 46 40](https://user-images.githubusercontent.com/90181761/207309694-8c9080f4-280f-421e-b330-3b4178aaa200.png) - The guides seem to pop out of nowhere. We could rename the "Index settings" heading to something more suitable. 2. Only keep `/learn/configuration/instance_options.md` under Configuration. Move the guides to "Advanced topics" ![Screen Shot 2022-12-13 at 15 54 12](https://user-images.githubusercontent.com/90181761/207311112-5706e7fd-ec78-4c38-a0a8-88269059367f.png) - The guides are very different from the current content under "Advanced topics". Should we create a new heading? - Makes it look like there isn't any content under "Configuration" 3. We only keep the ["Index settings"](/learn/configuration/settings.html#index-settings) table in `/learn/configuration/settings.md` - The reader will get a summary of the different settings without having to go to another page, and we can keep the guides here Co-authored-by: Maryam Sulemani <[email protected]> Co-authored-by: Maryam <[email protected]>
3 parents cc0218f + 17f7474 + 5616065 commit deb4fe5

File tree

13 files changed

+95
-390
lines changed

13 files changed

+95
-390
lines changed

.code-samples.meilisearch.yaml

Lines changed: 0 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -454,81 +454,6 @@ search_parameter_guide_show_matches_position_1: |-
454454
"q": "winter feast",
455455
"showMatchesPosition": true
456456
}'
457-
settings_guide_synonyms_1: |-
458-
curl \
459-
-X PATCH 'http://localhost:7700/indexes/tops/settings' \
460-
-H 'Content-Type: application/json' \
461-
--data-binary '{
462-
"synonyms": {
463-
"sweater": ["jumper"],
464-
"jumper": ["sweater"]
465-
}
466-
}'
467-
settings_guide_stop_words_1: |-
468-
curl \
469-
-X PATCH 'http://localhost:7700/indexes/movies/settings' \
470-
-H 'Content-Type: application/json' \
471-
--data-binary '{
472-
"stopWords": [
473-
"the",
474-
"a",
475-
"an"
476-
]
477-
}'
478-
settings_guide_ranking_rules_1: |-
479-
curl \
480-
-X PATCH 'http://localhost:7700/indexes/movies/settings' \
481-
-H 'Content-Type: application/json' \
482-
--data-binary '{
483-
"rankingRules": [
484-
"words",
485-
"typo",
486-
"proximity",
487-
"attribute",
488-
"sort",
489-
"exactness",
490-
"release_date:asc",
491-
"rank:desc"
492-
]
493-
}'
494-
settings_guide_distinct_1: |-
495-
curl \
496-
-X PATCH 'http://localhost:7700/indexes/jackets/settings' \
497-
-H 'Content-Type: application/json' \
498-
--data-binary '{ "distinctAttribute": "product_id" }'
499-
settings_guide_searchable_1: |-
500-
curl \
501-
-X PATCH 'http://localhost:7700/indexes/movies/settings' \
502-
-H 'Content-Type: application/json' \
503-
--data-binary '{
504-
"searchableAttributes": [
505-
"title",
506-
"overview",
507-
"genres"
508-
]
509-
}'
510-
settings_guide_displayed_1: |-
511-
curl \
512-
-X PATCH 'http://localhost:7700/indexes/movies/settings' \
513-
-H 'Content-Type: application/json' \
514-
--data-binary '{
515-
"displayedAttributes": [
516-
"title",
517-
"overview",
518-
"genres",
519-
"release_date"
520-
]
521-
}'
522-
settings_guide_sortable_1: |-
523-
curl \
524-
-X PATCH 'http://localhost:7700/indexes/books/settings' \
525-
-H 'Content-Type: application/json' \
526-
--data-binary '{
527-
"sortableAttributes": [
528-
"price",
529-
"author"
530-
]
531-
}'
532457
add_movies_json_1: |-
533458
curl \
534459
-X POST 'http://localhost:7700/indexes/movies/documents'\
@@ -898,16 +823,6 @@ typo_tolerance_guide_4: |-
898823
"twoTypos": 10
899824
}
900825
}'
901-
settings_guide_typo_tolerance_1: |-
902-
curl \
903-
-X PATCH 'http://localhost:7700/indexes/movies/settings/typo-tolerance' \
904-
-H 'Content-Type: application/json' \
905-
--data-binary '{
906-
"minWordSizeForTypos": {
907-
"twoTypos": 12
908-
},
909-
"disableOnAttributes": ["title"]
910-
}'
911826
updating_guide_check_version_new_authorization_header: |-
912827
curl \
913828
-X GET 'http://localhost:7700/version' \
@@ -936,13 +851,6 @@ getting_started_typo_tolerance: |-
936851
--data-binary '{
937852
"minWordSizeForTypos": { "oneTypo": 4 }
938853
}'
939-
settings_guide_pagination_1: |-
940-
curl \
941-
-X PATCH 'http://localhost:7700/indexes/movies/settings/pagination' \
942-
-H 'Content-Type: application/json' \
943-
--data-binary '{
944-
"maxTotalHits": 50
945-
}'
946854
get_pagination_settings_1: |-
947855
curl \
948856
-X GET 'http://localhost:7700/indexes/books/settings/pagination'
@@ -969,13 +877,6 @@ update_faceting_settings_1: |-
969877
reset_faceting_settings_1: |-
970878
curl \
971879
-X DELETE 'http://localhost:7700/indexes/books/settings/faceting'
972-
settings_guide_faceting_1: |-
973-
curl \
974-
-X PATCH 'http://localhost:7700/indexes/movies/settings/faceting' \
975-
-H 'Content-Type: application/json' \
976-
--data-binary '{
977-
"maxValuesPerFacet": 5
978-
}'
979880
synonyms_guide_1: |-
980881
curl \
981882
-X PUT 'http://localhost:7700/indexes/movies/settings/synonyms' \

.vuepress/public/sample-template.yaml

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,6 @@ search_parameter_guide_retrieve_1: |-
6868
search_parameter_guide_crop_1: |-
6969
search_parameter_guide_highlight_1: |-
7070
search_parameter_guide_show_matches_position_1: |-
71-
settings_guide_synonyms_1: |-
72-
settings_guide_stop_words_1: |-
73-
settings_guide_ranking_rules_1: |-
74-
settings_guide_distinct_1: |-
75-
settings_guide_searchable_1: |-
76-
settings_guide_displayed_1: |-
77-
settings_guide_sortable_1: |-
7871
getting_started_add_documents_md: |-
7972
getting_started_search_md: |-
8073
getting_started_check_task_status: |-
@@ -133,21 +126,18 @@ typo_tolerance_guide_1: |-
133126
typo_tolerance_guide_2: |-
134127
typo_tolerance_guide_3: |-
135128
typo_tolerance_guide_4: |-
136-
settings_guide_typo_tolerance_1: |-
137129
updating_guide_check_version_new_authorization_header: |-
138130
updating_guide_check_version_old_authorization_header: |-
139131
updating_guide_get_displayed_attributes_new: |-
140132
updating_guide_reset_displayed_attributes_new: |-
141133
updating_guide_create_dump: |-
142134
getting_started_typo_tolerance: |-
143-
settings_guide_pagination_1: |-
144135
get_pagination_settings_1: |-
145136
update_pagination_settings_1: |-
146137
reset_pagination_settings_1: |-
147138
get_faceting_settings_1: |-
148139
update_faceting_settings_1: |-
149140
reset_faceting_settings_1: |-
150-
settings_guide_faceting_1: |-
151141
synonyms_guide_1: |-
152142
getting_started_faceting: |-
153143
getting_started_pagination: |-

learn/advanced/filtering_and_faceted_search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ Please note that **synonyms don't apply to filters.** Meaning, if you have `SF`
276276

277277
#### Example
278278

279-
Suppose you have added `director` and `genres` to the [`filterableAttributes` list](/learn/configuration/settings.md#filterable-attributes), and you want to get movies classified as either `Horror` **or** `Mystery` **and** directed by `Jordan Peele`.
279+
Suppose you have added `director` and `genres` to the [`filterableAttributes` list](/reference/api/settings.md#filterable-attributes), and you want to get movies classified as either `Horror` **or** `Mystery` **and** directed by `Jordan Peele`.
280280

281281
```SQL
282282
[["genres = horror", "genres = mystery"], "director = 'Jordan Peele'"]

learn/advanced/indexing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If you encounter performance issues during indexing, we recommend trying the fol
5757
]
5858
```
5959

60-
- When creating a new index, first [configure its settings](/learn/configuration/settings.md) and only then add your documents. Following this order will significantly reduce indexing time.
60+
- When creating a new index, first [configure its settings](/reference/api/settings.md) and only then add your documents. Following this order will significantly reduce indexing time.
6161

6262
- Since indexing speed is tightly connected to the size of your payload, using lightweight dataset formats such as CSV and NDJSON can lead to increased performance.
6363

0 commit comments

Comments
 (0)