Skip to content

Commit

Permalink
parent 441d784
Browse files Browse the repository at this point in the history
author Charlotte Vermandel <charlotte@meilisearch.com> 1577980488 +0100
committer charlotte <cvermand@student.42.fr> 1584639620 +0100

parent 441d784
author Charlotte Vermandel <charlotte@meilisearch.com> 1577980488 +0100
committer charlotte <cvermand@student.42.fr> 1584636961 +0100

change version in title

Web interface

Config and gif

Changed stats route reference

Remove searchable attributes

Added documentation about the identifier

Changed information which was not correct

Added extended information about indentifier

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

typos

changed title

remove schemaless

Add .vuepress files

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

typos

changed title

remove schemaless

Add .vuepress files

Indexes guide

Removing old guide

Fixed links

Changed movie uid to movies, changed :index to :index_uid and removed uid name completely

Update guides/advanced_guides/ranking.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Changed uid to index uid and identifier to document_id when it ask for value and not attribute

Sentence changes

Update guides/main_concepts/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

wording

Update guides/main_concepts/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Add schemaless glossary, and changed wording

Fixed failing links

Remove existence of name in indexes

Identifier precisions

Identifier and changed some sentences

Added information about field in documents

Remove all schema

Update .vuepress/enhanceApp.js

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/main_concepts/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

wording

Spaces, typos, and wordinf

Changed delete batch documents route url

Starting settings

Settings route

Remove empty lines and errors in example

Ranking rules route

Add ranking rules to the router

Added settings route to router

Added every setting route and its references

Removed empty lines

Fixed dead links

Fix links

Update references/displayed_attributes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/searchable_attributes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/ranking_distinct.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/ranking_rules.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/ranking_rules.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/searchable_attributes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/ranking_rules.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/ranking_rules.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/ranking_rules.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/searchable_attributes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/searchable_attributes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/searchable_attributes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/settings.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/settings.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/settings.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/settings.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/settings.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/settings.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/settings.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Change

Update references/settings.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/settings.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/stop_words.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/settings.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/stop_words.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/synonyms.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/synonyms.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/synonyms.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/synonyms.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/synonyms.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/settings.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/stop_words.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/stop_words.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/stop_words.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/stop_words.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/synonyms.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Change api key to master key

Change key reference

Change key reference

Typos

Spaced

Changed wording

Fixes in links and information

Update guides/advanced_guides/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/keys.md

wording

Create relevancy guide (#163)

* Relevancy rule

Relevancy guide

Dead links fixes

Dit

Rules names

Remove path

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Small fixes

Fixes

remove old ranking guide

Fix dead links of old guide

Fix links

Lots of small changes

Fix dead links

Changed add with update on settings

Fix link

Update guides/main_concepts/search.md

Desc and Asc to lowercase and waning about the words rule

Outdated fixes

Update README.md

Co-Authored-By: Thomas Payet <thomas@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Thomas Payet <thomas@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Thomas Payet <thomas@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Thomas Payet <thomas@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Thomas Payet <thomas@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Thomas Payet <thomas@meilisearch.com>

Update references/distinct_attribute.md

Co-Authored-By: Thomas Payet <thomas@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Thomas Payet <thomas@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Thomas Payet <thomas@meilisearch.com>

Changing warning for words rule

* Dead link fixes

Update API references home page (#173)

Typos (#174)

* Comming to coming

* Ressource to resource

* His to its

* Comming to coming

* His to its

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/index_new_fields.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/stop_words.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/keys.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/ranking_rules.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update references/stop_words.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Update guides/advanced_guides/relevancy.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Apply suggestions from code review

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Changes in installation guide (#179)

* Changes in installation guide

* Typo

* Source wording

* bad char

* Update guides/advanced_guides/README.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

* Update guides/getting_started/quick_start_guide.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Co-authored-by: Clément Renault <renault.cle@gmail.com>
Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>

Remove debug compilation (#182)

* Remove building in debug mode from the documentation

* Added rustup update in compile example

* Consistency in phrasing

* New line between cmd's

Mandatory variable (#178)

Change stop words guide (#180)

* Change stop words guide

* Update guides/advanced_guides/stop_words.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

* Update guides/advanced_guides/stop_words.md

Co-Authored-By: Clément Renault <clement@meilisearch.com>

Co-authored-by: Clément Renault <renault.cle@gmail.com>

Move Relevancy and Updates (#176)

* Updates after search in API references

* Added Relevancy to the main concepts guide

Phrasing (#185)

Concat guide changes (#186)

* Concatenate and split queries changes

* remove new line

* Title case

* Remove unecessary word

* typo

* Added technical word

Remove timeout ms (#183)

Accept new fields file name changes and title changes (#184)

Update guides/advanced_guides/bucket_sort.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/installation.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/concat.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/installation.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/prefix.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/prefix.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/stop_words.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/synonyms.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/web_interface.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/getting_started/quick_start_guide.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/main_concepts/documents.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/main_concepts/indexes.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/main_concepts/indexes.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/main_concepts/indexes.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/main_concepts/indexes.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/main_concepts/indexes.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/main_concepts/indexes.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/concat.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/concat.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/keys.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/advanced_guides/synonyms.md

Update guides/advanced_guides/typotolerance.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/main_concepts/indexes.md

Removed duplicated line in keys (#192)

ordered sub menu (#190)

remove compression headers; fix #124 (#198)

Wording on relevancy for fields list

Web interface mention and changed to search guide (#200)

* Removed web

* Added web interface to getting started

* Wording, rephrasing, removed criterion, added web interface

* Remove unecessary wordd

* Update guides/main_concepts/search.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

* Update guides/main_concepts/search.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

* Update guides/main_concepts/search.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

* Update guides/main_concepts/search.md

* Update guides/main_concepts/search.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>
Co-authored-by: Quentin de Quelen <quentin@meilisearch.com>

Changes to key guide (#194)

* Changed to key

* Wording

* Update guides/advanced_guides/keys.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Co-authored-by: Quentin de Quelen <quentin@meilisearch.com>

Changes to fields properties (#191)

* Changed to fields properties

* Explained

* Title change

* Removed storedd from bullet point

* Update guides/main_concepts/indexes.md

* Update guides/main_concepts/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

* Update guides/main_concepts/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

* Update guides/main_concepts/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>

Review api reference (#201)

* remove compression headers; fix #124

* review the api reference architecture

Update guides/main_concepts/indexes.md

Co-Authored-By: Quentin de Quelen <quentin@meilisearch.com>

Update guides/main_concepts/indexes.md

Update guides/main_concepts/indexes.md

Change identifier to primary key (#189)

* Change identifier to primary key

* Fix links and typos

* Update references/indexes.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

* Update tutorials/quickstart/README.md

Co-Authored-By: Clémentine Urquizar <clementine@meilisearch.com>

Co-authored-by: Clémentine Urquizar <clementine@meilisearch.com>

Stop words wording (#203)

* Stop words wording

* Phrasing

* Update references/stop_words.md

Additional review (#196)

* fix some issues

* fix glossary component

* Additional information

Co-authored-by: charlotte <cvermand@student.42.fr>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

Glossary error
  • Loading branch information
bidoubiwa authored and charlotte committed Mar 19, 2020
1 parent 441d784 commit 286d8b8
Show file tree
Hide file tree
Showing 53 changed files with 2,167 additions and 2,188 deletions.
32 changes: 32 additions & 0 deletions .vuepress/components/glossary.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<template>
<tooltip :text="word" ><span v-html="glossary[word]"></span></tooltip>
</template>

<script>
const glossary = {
'field': "A field is composed of an <b>attribute</b> and its associated data. <br><br> Ex: <code>attribute: 'data'</code>",
'attribute': "The key associated to some data in a field. <br><br> Ex: <code>title: 'batman'</code> <br> title is the attribute in this example.",
'ranking rules': "Rules that are used by MeiliSearch to determine the relevancy of a document. <br><br> For example, the number of typos or the number of times the matching query is found in a document.",
'primary key': 'The attribute in a document of its unique identifier field. <br><br> Used by MeiliSearch to store the document. <br><br> Example: `movie_id` is the primary key of a movie document.',
'schemaless': 'This means you don\'t need to define or describe the structure of your data before adding data to an index. <br><br> For example, SQL\'s tables need schemas but mongodb\'s collections does not require it.',
'searchable': 'The data is used to determine the relevancy of a document when doing a search query.',
'displayed': 'The field is present in the document returned upon search.'
}
export default {
props: {
'word': {
type: String,
validator: function (x) {
return glossary[x];
}
}
},
data: () => {
return {
glossary
}
}
}
</script>
48 changes: 48 additions & 0 deletions .vuepress/components/tooltip.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<template>
<span>
<span class="tooltip-text" v-tooltip.top.hover.focus="{
ref: 'tooltipRef',
class: 'tooltip-custom'
}">{{ text }}</span>
<div ref="tooltipRef" class="tooltip-content">
<slot></slot>
</div>
</span>
</template>

<script>
export default {
name: 'tooltip',
props: {
info: {
default: 'info box',
type: String
},
text: {
default: 'text',
type: String
}
}
};
</script>

<style lang="scss">
@import "~vue-directive-tooltip/src/css/index.scss";
.tooltip-text{
font-style: italic;
border-bottom: 1px dotted gray;
position: relative;
}
.tooltip-text:after {
content: "";
color: gray;
font-size: 9px;
position: absolute;
top: 0px;
right: -7px;
}
.vue-tooltip.tooltip-custom {
background-color: rgba(0,0,0,0.8);
padding: 15px 20px;
}
</style>
43 changes: 30 additions & 13 deletions .vuepress/config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
let ogprefix = 'og: http://ogp.me/ns#'
module.exports = {
title: "MeiliSearch Documentation",
title: "MeiliSearch Documentation v0.9",
description: "Open source Instant Search Engine",
themeConfig: {
repo: "meilisearch/MeiliSearch",
Expand Down Expand Up @@ -34,25 +34,26 @@ module.exports = {
children: [
"/guides/main_concepts/indexes",
"/guides/main_concepts/documents",
"/guides/main_concepts/search"
"/guides/main_concepts/search",
"/guides/main_concepts/relevancy"
]
},
{
title: "📚 Advanced Guides",
path: "/guides/advanced_guides/",
collapsable: false,
children: [
"/guides/advanced_guides/binary",
"/guides/advanced_guides/typotolerance",
"/guides/advanced_guides/concat",
"/guides/advanced_guides/ranking",
"/guides/advanced_guides/synonyms",
"/guides/advanced_guides/stop_words",
"/guides/advanced_guides/installation",
"/guides/advanced_guides/search_parameters",
"/guides/advanced_guides/keys",
"/guides/advanced_guides/asynchronous_updates",
"/guides/advanced_guides/web_interface",
"/guides/advanced_guides/synonyms",
"/guides/advanced_guides/stop_words",
"/guides/advanced_guides/prefix",
"/guides/advanced_guides/typotolerance",
"/guides/advanced_guides/concat",
"/guides/advanced_guides/distinct",
"/guides/advanced_guides/asynchronous_updates",
"/guides/advanced_guides/bucket_sort"
]
}
Expand All @@ -72,11 +73,26 @@ module.exports = {
"/references/indexes",
"/references/documents",
"/references/search",
"/references/synonyms",
"/references/stop_words",
"/references/updates",
"/references/keys",
"/references/settings",
{
title: 'Settings',
path: '/references/settings',
collapsable: false,
children: [
{
title: 'All Settings',
path: '/references/settings'
},
"/references/synonyms",
"/references/stop_words",
"/references/ranking_rules",
"/references/distinct_attribute",
"/references/searchable_attributes",
"/references/displayed_attributes",
"/references/accept_new_fields",
]
},
"/references/stats",
"/references/health",
"/references/version",
Expand Down Expand Up @@ -123,7 +139,8 @@ module.exports = {
["sitemap", { hostname: "https://docs.meilisearch.com" }],
["seo", {}],
"vuepress-plugin-element-tabs",
['vuepress-plugin-container', { type: 'note' }]
['vuepress-plugin-container', { type: 'note' }],
['vue-directive-tooltip']
],
head: [
["meta", { charset: "utf-8" }],
Expand Down
8 changes: 8 additions & 0 deletions .vuepress/enhanceApp.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import Tooltip from 'vue-directive-tooltip';
import 'vue-directive-tooltip/dist/vueDirectiveTooltip.css';

export default ({
Vue, // the version of Vue being used in the VuePress app
}) => {
Vue.use(Tooltip);
}
Binary file added .vuepress/public/movies_web_2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

MeiliSearch is a **RESTful search API** that is the **ready-to-go solution** for everyone wanting a **powerful, fast, and relevant search experience** for their end-users ⚡️🔎

<linkButton method="GET" text="🚀 GETTING STARTED" url="/guides/introduction/quick_start_guide.html"/>
<linkButton method="GET" text="🚀 GETTING STARTED" url="/guides/getting_started/quick_start_guide.html"/>

Efficient search engines are often only accessible to companies with the financial means and resources necessary to develop a search solution adapted to their needs. The majority of other companies that do not have the means or do not realize that the lack of relevance of a search greatly impacts the pleasure of navigation on their application,
end up with poor solutions that are more frustrating than effective, for both the developer and the user.
Expand Down Expand Up @@ -36,8 +36,9 @@ Why should you use MeiliSearch instead of any other existing solution? If it is
* [Tokenization](https://en.wikipedia.org/wiki/Lexical_analysis#Tokenization) in English, kanji and latin based languages.
* **Return the whole document**: The entire document is returned upon search.
* **Highly customizable search and indexation**:
- [Custom ranking](/guides/advanced_guides/ranking.md#custom-ranking-rules): Create your own ranking rules on indexation.
- [Stop-words](/guides/advanced_guides/stop_words.md): Ignore common non-relevant words like `of`, `the`, ..
- [Custom ranking](/guides/main_concepts/relevancy.md): Customize the relevancy of the search engine and the ranking of the search results.
- [Stop words](/guides/advanced_guides/stop_words.md): Ignore common non-relevant words like `of` or `the`.
- [Highlights](/guides/advanced_guides/search_parameters.md#attributes-to-highlight): Highlighted search results in documents
- Ability to create [synonyms](/guides/advanced_guides/synonyms.md) for a better search experience.
* **RESTful API**
* **Friendly web interface**: [Integrated web interface](/guides/advanced_guides/web_interface) in MeiliSearch that lets you try the search engine when developing.
10 changes: 5 additions & 5 deletions guides/advanced_guides/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Advanced guides

In the advanced guides you will find how to tune your search API and customize it:
- [MeiliSearch Binary](binary.md)
- [Stop words](stop_words.md)
- [How to install MeiliSearch](installation.md)
- [Search parameters](search_parameters.md)
- [Keys](keys.md)
- [Synonyms](synonyms.md)
- [Stop words](stop_words.md)
- [Distinct](distinct.md)
- [Keys](keys.md)

You can also read the following articles to understand how MeiliSearch works under the hood and better understand the algorithms used:

- [Asynchronous updates](asynchronous_updates.md)
- [Prefix search](prefix.md)
- [Web interface](web_interface.md)
- [Typo Tolerance](typotolerance.md)
- [Concatenate and split queries](concat.md)
- [Bucket sort](bucket_sort.md)
- [Ranking](ranking.md)
- [Asynchronous updates](asynchronous_updates.md)
17 changes: 1 addition & 16 deletions guides/advanced_guides/asynchronous_updates.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Asynchronous Updates
# Asynchronous Updates

MeiliSearch is an **asynchronous API**. It means that the API does not behave as you would typically expect when handling the request's responses.

Expand Down Expand Up @@ -28,7 +28,6 @@ sequenceDiagram
### Which operations are async?

Every operation which could be compute-expensive is asynchronous. These include:
- Create/update a schema
- Update index settings
- Add/update/delete documents

Expand Down Expand Up @@ -58,20 +57,6 @@ Adding documents:
}
```

Updating a schema:
```json
{
"status": "processed",
"updateId": 0,
"type": {
"name": "Schema"
},
"duration": 0.000041072,
"enqueuedAt": "2019-12-07T21:10:07.506281864Z",
"processedAt": "2019-12-07T21:10:07.684496732Z"
}
```

Failing to upload document:
```json
{
Expand Down
4 changes: 2 additions & 2 deletions guides/advanced_guides/bucket_sort.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

A [bucket sort](https://en.wikipedia.org/wiki/Bucket_sort) can be described as an ordered set of sorting `criteria`.

All the documents are sorted within the first `criterion`, then documents that can not be distinguished will be sorted using the second criterion, and so on. Thus, every document are not sorted for every criterion which induces a reduced compute time.
All the documents are sorted within the first `criterion`, then documents that can not be distinguished will be sorted using the second criterion, and so on. Thus, all documents are not sorted for every criterion, which induces a reduced compute time.

[Here is the ordered list of the default criteria used in MeiliSearch](/guides/advanced_guides/ranking.md#ranking-rules)
[Here is the ordered list of the default criteria used in MeiliSearch.](/guides/main_concepts/relevancy.md#ranking-rules)
21 changes: 12 additions & 9 deletions guides/advanced_guides/concat.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,33 @@
# Concatenate and split queries
# Concatenate and Split Queries

## Concatenated queries
## Concatenated Queries

When your search contains several words, MeiliSearch applies a concatenation algorithm to it.

This means that a search is also done on the concatenation of those words.
When searching for multiple words, a search is also done on the concatenation of those words. When concatenation is done on a search query containing multiple words, it will concatenate the words following each other. Thus, the first and third words will not be concatenated without the second word.

#### Example

A search on `news paper` searches with the following queries:
- News paper
- Newspaper
A search on `The news paper` will also search for the following concatenated queries:
- `Thenews paper`
- `the newspaper`
- `Thenewspaper`

::: warning
This concatenation is done on a **maximum of 3 words**.
:::

## Splitted queries
## Split Queries

When you do a search, it **applies the splitting algorithm to every word** (*string separated by a space*).

This consists of finding the most interesting place to separate the words and to create a parallel search query with this proposition.

This is achieved by finding the best frequency of the separate words in the dictionary of all words in the dataset. It will look out that both words have a minimum of interesting results, and not just one of them.
#### Example

On a search on "newspaper", it will splits into "news" and "paper" and not into "new" and "spaper".
Split words are not considered as multiple words in a search query because they must stay next to each other, this behavior is called **Phrase Queries**.

#### Example

On a search on `newspaper`, it will split into `news` and `paper` and not into `new` and `spaper`.
A document containing `news` and `paper` separated by other words will not be relevant to the search.
7 changes: 3 additions & 4 deletions guides/advanced_guides/distinct.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

A field can be set as `distinct`.

When a field is `distinct`, there will **never be two, or more, occurence of the same value of that attribute** in the different documents that are returned by MeiliSearch.
When a field is `distinct`, there will **never be two, or more, occurrence of the same value of that attribute** in the different documents that are returned by MeiliSearch.

### Example

Let's use the following documents sample with 3 jackets of **different `colors`** but **same `skuid`**:
Let's use the sample of the following documents with 3 jackets of **different `colors`** but **same `skuid`**:
```json
[
{
Expand All @@ -30,8 +30,7 @@ Let's use the following documents sample with 3 jackets of **different `colors`*
]
```


By [setting `skuid` as a distinct field](/references/settings.md#distinct-field):
By [setting `skuid` as a distinct field](/references/distinct_attribute.md):

```bash
$ curl
Expand Down
Loading

0 comments on commit 286d8b8

Please sign in to comment.