Merge #308

308: Code samples update r=brunoocasali a=brunoocasali

Add/Update code samples according to #308 
 
Fixes #306 

Co-authored-by: Bruno Casali <[email protected]>

Author: meili-bors[bot]

.code-samples.meilisearch.yaml

@@ -8,7 +8,9 @@ get_one_index_1: |-
 list_all_indexes_1: |-
   client.indexes
 create_an_index_1: |-
-  client.create_index('movies', primary_key: 'movie_id')
+  client.create_index('movies', primary_key: 'id')
+document_guide_create_index_primary_key: |-
+  client.create_index('movies', primary_key: 'reference_number')
 update_an_index_1: |-
   client.index('movies').update(primary_key: 'movie_id')
 delete_an_index_1: |-
@@ -17,6 +19,16 @@ get_one_document_1: |-
   client.index('movies').document(25684)
 get_documents_1: |-
   client.index('movies').documents(limit: 2)
+document_guide_add_document_primary_key: |-
+  client.index('movies').add_documents([
+    {
+      reference_number: 287947,
+      title: 'Shazam',
+      poster: 'https://image.tmdb.org/t/p/w1280/xnopI5Xtky18MPhK40cZAGAOVeV.jpg',
+      overview: 'A boy is given the ability to become an adult superhero in times of need with a single magic word.',
+      release_date: '2019-03-23'
+    }
+  ], 'reference_number')
 add_or_replace_documents_1: |-
   client.index('movies').add_documents([
     {
@@ -68,13 +80,13 @@ update_settings_1: |-
     distinct_attribute: 'movie_id',
     searchable_attributes: [
       'title',
-      'description',
-      'genre'
+      'overview',
+      'genres'
     ],
     displayed_attributes: [
       'title',
-      'description',
-      'genre',
+      'overview',
+      'genres',
       'release_date'
     ],
     stop_words: [
@@ -135,8 +147,8 @@ get_searchable_attributes_1: |-
 update_searchable_attributes_1: |-
   client.index('movies').update_searchable_attributes([
     'title',
-    'description',
-    'genre'
+    'overview',
+    'genres'
   ])
 reset_searchable_attributes_1: |-
   client.index('movies').reset_searchable_attributes
@@ -154,8 +166,8 @@ get_displayed_attributes_1: |-
 update_displayed_attributes_1: |-
   client.index('movies').update_displayed_attributes([
     'title',
-    'description',
-    'genre',
+    'overview',
+    'genres',
     'release_date'
   ])
 reset_displayed_attributes_1: |-
@@ -173,15 +185,15 @@ distinct_attribute_guide_1: |-
 field_properties_guide_searchable_1: |-
   client.index('movies').update_searchable_attributes([
     'title',
-    'description',
-    'genre'
+    'overview',
+    'genres'
   ])
 field_properties_guide_displayed_1: |-
   client.index('movies').update_settings({
     displayed_attributes: [
       'title',
-      'description',
-      'genre',
+      'overview',
+      'genres',
       'release_date'
     ]
   })
@@ -192,8 +204,6 @@ filtering_guide_2: |-
     filter: 'release_date > 795484800 AND (director = "Tim Burton" OR director = "Christopher Nolan")'
   })
 filtering_guide_3: |-
-  client.index('movies').search('horror', { filter: 'director = "Jordan Peele"' })
-filtering_guide_4: |-
   client.index('movies').search('Planet of the Apes', {
     filter: 'rating >= 3 AND (NOT director = "Tim Burton")'
   })
@@ -224,14 +234,6 @@ search_parameter_guide_matches_1: |-
   client.index('movies').search('winter feast', {
     matches: true
   })
-search_parameter_guide_filter_1: |-
-  client.index('movies').search('n', {
-    filter: 'title = Nightshift'
-  })
-search_parameter_guide_filter_2: |-
-  client.index('movies').search('shifu', {
-    filter: 'title="Kung Fu Panda"'
-  })
 settings_guide_synonyms_1: |-
   client.index('tops').update_settings({
     synonyms: {
@@ -266,16 +268,16 @@ settings_guide_searchable_1: |-
   client.index('movies').update_settings({
     searchable_attributes: [
       'title',
-      'description',
-      'genre'
+      'overview',
+      'genres'
     ]
   })
 settings_guide_displayed_1: |-
   client.index('movies').update_settings({
     displayed_attributes: [
       'title',
-      'description',
-      'genre',
+      'overview',
+      'genres',
       'release_date'
     ]
   })
@@ -297,15 +299,6 @@ documents_guide_add_movie_1: |-
     "movie_id": "123sq178",
     "title": "Amelie Poulain"
   }])
-search_guide_1: |-
-  client.index('movies').search('shifu', {
-    limit: 5,
-    offset: 10
-  })
-search_guide_2: |-
-  client.index('movies').search('Avengers', {
-    filter: 'release_date > 795484800'
-  })
 getting_started_add_documents_md: |-
   ```bash
   $ bundle add meilisearch
@@ -343,21 +336,10 @@ faceted_search_facets_distribution_1: |-
   client.index('movies').search('Batman', {
     facets_distribution: ['genres']
   })
-faceted_search_walkthrough_filterable_attributes_1: |-
-  client.index('movies').update_filterable_attributes([
-    'director',
-    'producer',
-    'genres',
-    'production_companies'
-  ])
 faceted_search_walkthrough_filter_1: |-
   client.index('movies').search('thriller', {
     filter: [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"']
   })
-faceted_search_walkthrough_facets_distribution_1: |-
-  client.index('movies').search('Batman', {
-    facets_distribution: ['genres']
-  })
 post_dump_1: |-
   client.create_dump
 get_dump_status_1: |-
@@ -393,15 +375,15 @@ search_parameter_guide_sort_1: |-
 geosearch_guide_filter_settings_1: |-
   client.index('restaurants').update_filterable_attributes(['_geo'])
 geosearch_guide_filter_usage_1: |-
-  client.index('restaurants').search('', { filter: '_geoRadius(45.4628328, 9.1076931, 2000)' })
+  client.index('restaurants').search('', { filter: '_geoRadius(45.472735, 9.184019, 2000)' })
 geosearch_guide_filter_usage_2: |-
-  client.index('restaurants').search('', { filter: '_geoRadius(45.4628328, 9.1076931, 2000) AND type = pizza' })
+  client.index('restaurants').search('', { filter: '_geoRadius(45.472735, 9.184019, 2000) AND type = pizza' })
 geosearch_guide_sort_settings_1: |-
   client.index('restaurants').update_sortable_attributes(['_geo'])
 geosearch_guide_sort_usage_1: |-
-  client.index('restaurants').search('', { sort: ['_geoPoint(48.8583701,2.2922926):asc'] })
+  client.index('restaurants').search('', { sort: ['_geoPoint(48.8561446, 2.2978204):asc'] })
 geosearch_guide_sort_usage_2: |-
-  client.index('restaurants').search('', { sort: ['_geoPoint(48.8583701,2.2922926):asc', 'rating:desc'] })
+  client.index('restaurants').search('', { sort: ['_geoPoint(48.8561446, 2.2978204):asc', 'rating:desc'] })
 authorization_header_1: |-
   client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'masterKey')
   client.keys
@@ -468,3 +450,68 @@ tenant_token_guide_search_sdk_1: |-
   front_end_client = MeiliSearch::Client.new('http://127.0.0.1:7700', token)
 
   front_end_client.index('patient_medical_records').search('blood test')
+getting_started_update_rankingRules: |-
+  client.index('movies').update_ranking_rules([
+    'exactness',
+    'words',
+    'typo',
+    'proximity',
+    'attribute',
+    'sort',
+    'release_date:asc',
+    'rank:desc'
+  ])
+getting_started_update_searchableAttributes: |-
+  client.index('movies').update_searchable_attributes([
+    'title'
+  ])
+getting_started_update_stop_words: |-
+  client.index('movies').update_stop_words(['the'])
+getting_started_check_task_status: |-
+  client.index('movies').task(0)
+getting_started_synonyms: |-
+  client.index('movies').update_synonyms({
+    winnie: ['piglet'],
+    piglet: ['winnie']
+  })
+getting_started_update_displayedAttributes: |-
+  client.index('movies').update_displayed_attributes([
+    'title',
+    'overview',
+    'poster'
+  ])
+getting_started_communicating_with_a_protected_instance: |-
+  client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'apiKey')
+  client.index('movies').search
+getting_started_add_meteorites: |-
+  file = File.read('meteorites.json')
+  json = JSON.parse(file)
+
+  client.index('meteorites').add_documents(json)
+getting_started_configure_settings: |-
+  client.index('meteorites').update_settings({
+    filterable_attributes: ['mass', '_geo'],
+    sortable_attributes: ['mass', '_geo']
+  })
+getting_started_geoRadius: |-
+  client.index('meteorites').search('', { filter: '_geoRadius(46.9480, 7.4474, 210000)' })
+getting_started_geoPoint: |-
+  client.index('meteorites').search('', { sort: ['_geoPoint(48.8583701, 2.2922926):asc'] })
+getting_started_sorting: |-
+  client.index('meteorites').search('', {
+    sort: ['mass:asc'],
+    filter: 'mass < 200'
+  })
+getting_started_filtering: |-
+  client.index('meteorites').search('', { filter: 'mass < 200' })
+landing_getting_started_1: |-
+  client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'masterKey')
+
+  client.index('movies').add_documents([
+    { id: 1, title: 'Carol' },
+    { id: 2, title: 'Wonder Woman' },
+    { id: 3, title: 'Life of Pi' },
+    { id: 4, title: 'Mad Max: Fury Road' },
+    { id: 5, title: 'Moana' },
+    { id: 6, title: 'Philadelphia' }
+  ])