Skip to content

Commit 184c6bf

Browse files
guimachiavelliguimachiavelli
authored
Merge branch 'master' into v0.28
2 parents 8aa9b7a + baed4b9 commit 184c6bf

30 files changed

+669
-393
lines changed

‎.code-samples.meilisearch.yaml

Lines changed: 315 additions & 278 deletions
Large diffs are not rendered by default.

‎.vale.ini

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
StylesPath = .vale/styles
2+
MinAlertLevel = suggestion
3+
4+
Vocab = word_list
5+
6+
[*.md]
7+
BasedOnStyles = style_guide
8+
9+
#style_guide.Headings = NO
10+
#style_guide.HeadingPunctuation = NO

‎.vale/styles/Vocab/word_list/accept.txt

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
Meilisearch
2+
[Ss]ubroute
3+
[Ss]ubstring
4+
uid
5+
jq
6+
Qovery
7+
Koyeb
8+
Vue
9+
[Gg]eosearch
10+
Nginx
11+
Docxtemplater
12+
[Cc]onfig
13+
Algolia
14+
Typesense
15+
Symfony
16+
Laravel
17+
Strapi
18+
[Ss]chemaless
19+
[Rr]eindexed
20+
chatbox
21+
Lucene
22+
Levenshtein
23+
Swiftype
24+
[Tt]okenizer
25+
[Tt]okenization
26+
[Aa]sync
27+
[Ee]nqueued
28+
[Ff]ilepath
29+
[Ww]ebshop
30+
boolean
31+
Taj
32+
Mahal
33+
[Cc]ertbot
34+
[Tt]oolchain
35+
Jieba
36+
Lindera
37+
Netlify
38+
[Oo]verconsumption
39+
[Gg]eopositioning
40+
hanzi
41+
[Aa]utobatching
42+
[Ii]mpactful
43+
[Ll]owercased
44+
[Mm]ultitenancy
45+
[Rr]ulesets
46+
[Pp]repended
47+
[Aa]nonymized
48+
[Ss]erverless
49+
[Aa]utoscaling
50+
[Hh]ostname
51+
Scaleway
52+
cron
53+
mkcert
54+
[Uu]pvote
55+
Docsearch
56+
[Oo]rderable
57+
[Pp]erformant
58+
Nutch
59+
[Ss]ubproject
60+
Doofinder
61+
'/\(\B(.*?)\)'
62+
[Ss]harding
63+
[Mm]eili
64+
jsonlines
65+
Biutiful
66+
Gb
67+
docs-searchbar.js

‎.vale/styles/Vocab/word_list/reject.txt

Whitespace-only changes.

‎.vale/styles/style_guide/FirstPerson.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
# Suggestion: style_guide.FirstPerson
3+
4+
# We want to avoid using singular first person pronouns
5+
extends: existence
6+
message: "Avoid first-person pronouns such as '%s'."
7+
link: 'https://developers.google.com/style/pronouns#personal-pronouns'
8+
ignorecase: true
9+
level: suggestion
10+
nonword: true
11+
tokens:
12+
- (?:^|\s)I\s
13+
- (?:^|\s)I,\s
14+
- \bI'm\b
15+
- \bme\b
16+
- \bmy\b
17+
- \bmine\b

‎.vale/styles/style_guide/HeadingPunctuation.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
# Suggestion: style_guide.HeadingPunctuation.yml
3+
4+
# Need to update this for "1. Click this" "1.1. Click that"
5+
# Our headings should not use end punctuation
6+
extends: existence
7+
message: "Don't use end punctuation in headings."
8+
link: https://developers.google.com/style/periods
9+
level: suggestion
10+
scope: heading
11+
tokens:
12+
- '[a-z0-9][.?!](?:\s|$)'

‎.vale/styles/style_guide/Headings.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
# Suggestion: style_guide.Headings.yml
3+
4+
# Our headings should use sentence-style capitalization. The exceptions include any headings that maybe a list, start with "Step 1: Do this", and the list of words below
5+
extends: capitalization
6+
message: "'%s' should use sentence-style capitalization."
7+
link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings'
8+
level: suggestion
9+
scope: heading
10+
match: $sentence
11+
indicators:
12+
- ':'
13+
exceptions:
14+
- Azure
15+
- CLI
16+
- Code
17+
- Docker
18+
- SDK
19+
- SDKs
20+
- Kubernetes
21+
- Linux
22+
- macOS
23+
- Marketplace
24+
- MongoDB
25+
- TypeScript
26+
- URLs
27+
- Visual
28+
- VS
29+
- Windows
30+
- Meilisearch
31+
- AWS
32+
- Amazon Web Services
33+
- DigitalOcean
34+
- GCP
35+
- Qovery
36+
- GCP
37+
- Google Cloud Platform
38+
- Compute Engine
39+
- GitHub
40+
- JSON
41+
- API
42+
- VuePress
43+
- OpenAPI
44+
- Elasticsearch
45+
- Algolia
46+
- DevOps
47+
- Lucene-Solr
48+
- App Service Auto-Scale
49+
- Certbot
50+
- Bleve & Tantivy
51+
- '([0-9a-z]:\s[A-Z])' #How do get this to throw an error for `Step 1: do this`?

‎.vale/styles/style_guide/Meilisearch.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
# Error: style_guide.Meilisearch.yml
3+
4+
# Lists any possible typos for Meilisearch
5+
extends: substitution
6+
message: "Use '%s' instead of '%s'."
7+
level: error
8+
swap:
9+
MeiliSearch: Meilisearch
10+
MieliSearch: Meilisearch
11+
meiliSearch: Meilisearch

‎.vale/styles/style_guide/MergeConflictMarkers.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
# Error: style_guide.MergeConflictMarkers.yml
3+
4+
# Checks for the presence of merge conflict markers.
5+
extends: existence
6+
message: 'Merge conflict marker "%s" found.'
7+
link: https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request
8+
level: error
9+
scope: raw
10+
raw:
11+
- '\n<<<<<<< .+\n|\n=======\n|\n>>>>>>> .+\n'
12+

‎.vale/styles/style_guide/OxfordComma.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
# Suggestion: style_guide.OxfordComma.yml
3+
4+
# Use the Oxford comma, this may not work as intended for complex sentences with many commas
5+
extends: existence
6+
message: "Use the Oxford comma in '%s'."
7+
link: 'https://developers.google.com/style/commas'
8+
scope: sentence
9+
level: suggestion
10+
tokens:
11+
- '(?:[^,]+,){1,}\s\w+\s(?:and|or)'

‎.vale/styles/style_guide/Periods.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
# Suggestion: style_guide.Period.yml
3+
4+
# Don't use periods with acronyms. "H.T.M.L" is incorrect, HTML isn't
5+
6+
extends: existence
7+
message: "Don't use periods with acronyms or initialisms such as '%s'."
8+
link: 'https://developers.google.com/style/abbreviations'
9+
level: suggestion
10+
nonword: true
11+
tokens:
12+
- '\b(?:[A-Z]\.){3,}'

‎.vale/styles/style_guide/Repetition.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
# Error: style_guide.Repetition.yml
3+
4+
# catch any instances of repeated words. E.g., "This is is a sentence"
5+
extends: repetition
6+
message: "'%s' is repeated."
7+
level: error
8+
alpha: true
9+
tokens:
10+
- '[^\s]+'

‎.vale/styles/style_guide/Semicolons.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
# Suggestion: style_guide.Semicolons.yml
3+
4+
# If your sentence uses a semicolon, you should break it into two sentences or rewrite it to avoid super long sentences.
5+
extends: existence
6+
message: "Use semicolons judiciously."
7+
link: 'https://developers.google.com/style/semicolons'
8+
nonword: true
9+
scope: sentence
10+
level: suggestion
11+
tokens:
12+
- ';'

‎.vale/styles/style_guide/Spacing.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
# Error: style_guide.Spacing.yml
3+
4+
# Use a space between words, sentences, and punctuation marks
5+
extends: existence
6+
message: "'%s' should have one space."
7+
link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
8+
level: error
9+
nonword: true
10+
tokens:
11+
- '[a-z]\s{2,}[a-z]' # ensure only one space between words
12+
- '[a-z][.?!:;",] {2,}[A-Z]' # one space between sentences (end. new)
13+
- '[a-z][.?!:;",][A-Z]' #(end.new)
14+
- '[\w.?!,\(\)\-":] {2,}[\w.?!,\(\)\-":]' #only one space after ,.?
15+

‎.vale/styles/style_guide/Spelling.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
# Warning: style_guide.Spelling.yml
3+
4+
# Checks if your words exist in the dictionary. Any exceptions (including Meilisearch) should be defined in `styles/Vocab/word_list/accept.txt`
5+
extends: spelling
6+
message: "Did you really mean '%s'?"
7+
level: warning
8+
filters:
9+
- 'Vale.*\b'

‎.vale/styles/style_guide/URLFormat.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
# Warning: style_guide.URLFormat.yml
3+
4+
# Use "a URL"/"an HTML" instead of "an URL"/"a HTML"
5+
extends: substitution
6+
message: "Use '%s' instead of '%s'."
7+
ignorecase: true
8+
level: warning
9+
action:
10+
name: replace
11+
swap:
12+
URL for: URL of
13+
an URL: a URL
14+
a HTML: an HTML

‎.vuepress/public/sample-template.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,6 @@ settings_guide_distinct_1: |-
7373
settings_guide_searchable_1: |-
7474
settings_guide_displayed_1: |-
7575
settings_guide_sortable_1: |-
76-
documents_guide_add_movie_1: |-
7776
getting_started_add_documents_md: |-
7877
getting_started_search_md: |-
7978
getting_started_check_task_status: |-

‎learn/advanced/datatypes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Once all objects inside a document have been flattened, Meilisearch will continu
185185

186186
## Possible tokenization issues
187187

188-
Even if it behaves exactly as expected, the tokenization process may lead to unintuitive results in some cases, such as:
188+
Even if it behaves exactly as expected, the tokenization process may lead to counterintuitive results in some cases, such as:
189189

190190
```
191191
"S.O.S"

‎learn/advanced/dumps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The above code sample returns an object with the following details about the dum
3737
}
3838
```
3939

40-
After dump creation is finished, the dump file is added to the dump directory. By default, this folder is named `dumps` and can be found in the same directory as your Meilisearch binary. You can customize [this using the `--dumps-dir` configuration option](/learn/configuration/instance_options.md#dumps-destination). **If the dump directory does not already exist when the dump creation process is called, Meilisearch will create it.**
40+
After dump creation is finished, the dump file is added to the dump directory. By default, this folder is named `dumps` and can be found in the same directory as your Meilisearch binary. You can customize [this using the `--dumps-dir` configuration option](/learn/configuration/instance_options.md#dumps-destination). **If the dump directory does not already exist when the dump creation process is called, Meilisearch will create it.**
4141

4242
If a dump file is visible in the file system, the dump process was successfully completed. **Meilisearch will never create a partial dump file**, even if you interrupt an instance while it is generating a dump.
4343

‎learn/advanced/known_limitations.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,19 @@ This guide covers hard limits that cannot be altered. Meilisearch also has some
66

77
## Maximum number of query words
88

9-
**Limitation:** The maximum number of terms taken into account for each [search query](/reference/api/search.md#query-q) is 10. **If a search query includes more than 10 words, all words after the 10th will be ignored.**
9+
**Limitation:** The maximum number of terms taken into account for each [search query](/reference/api/search.md#query-q) is 10. If a search query includes more than 10 words, all words after the 10th will be ignored.
1010

1111
**Explanation:** Queries with many search terms can lead to long response times. This goes against our goal of providing a [fast search-as-you-type experience](/learn/what_is_meilisearch/philosophy.md#front-facing-search).
1212

13+
## Maximum number of document fields
14+
15+
**Limitation:** Documents have a soft maximum of 1000 fields.
16+
17+
**Explanation:** There is no limit on how many fields a document can have. However, documents with more than 1000 fields may cause the [ranking rules](/learn/core_concepts/relevancy.md#ranking-rules) to stop working, leading to undefined behavior.
18+
1319
## Maximum number of words per attribute
1420

15-
**Limitation:** Meilisearch can index a maximum of **65535 positions per attribute**. Any words exceeding the 65535 position limit will be silently ignored.
21+
**Limitation:** Meilisearch can index a maximum of 65535 positions per attribute. Any words exceeding the 65535 position limit will be silently ignored.
1622

1723
**Explanation:** This limit is enforced for relevancy reasons. The more words there are in a given attribute, the less relevant the search queries will be.
1824

@@ -55,7 +61,7 @@ If your query is `Hello - World`:
5561

5662
**Limitation:** An index can contain no more than 4,294,967,296 documents.
5763

58-
**Explanation:** This is the largest possible value for a 32-bit unsigned integer. Since Meilisearch's engine uses unsigned integers to identify documents internally, this is the maximum number of documents that can be stored in an index.
64+
**Explanation:** This is the largest possible value for a 32-bit unsigned integer. Since Meilisearch's engine uses unsigned integers to identify documents internally, this is the maximum number of documents that can be stored in an index.
5965

6066
## Length of individual `filterableAttributes` values
6167

‎learn/advanced/updating.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If you have already **installed the latest version and manually indexed your dat
1313
Before we begin, you need to **verify the version of Meilisearch that's compatible with your database**, i.e. the version that indexed the data. You can do so by launching a Meilisearch instance:
1414

1515
```bash
16-
./meilisearch --master-key="your_master_key"
16+
./meilisearch --master-key="MASTER_KEY"
1717
```
1818

1919
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).
@@ -243,7 +243,7 @@ Now that you’ve got your dump, [install the latest version of Meilisearch](/le
243243

244244
```bash
245245
# launch the latest version of Meilisearch with the master key and import the specified dump file
246-
./meilisearch --import-dump /dumps/your_dump_file.dump --master-key="your_master_key"
246+
./meilisearch --import-dump /dumps/your_dump_file.dump --master-key="MASTER_KEY"
247247
```
248248

249249
::: warning

‎learn/configuration/displayed_searchable_attributes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ There are two possible modes for the `searchableAttributes` list.
3636

3737
This default behavior is indicated by a `searchableAttributes` value of `["*"]`. To verify the current value of your `searchableAttributes` list, use the [get searchable attributes endpoint](/reference/api/searchable_attributes.md#get-searchable-attributes).
3838

39-
If you'd like to restore your searchable attributes list to this default behavior, simply [set `searchableAttributes` to an empty array `[]`](/reference/api/searchable_attributes.md#update-searchable-attributes) or use the [reset searchable attributes endpoint](/reference/api/searchable_attributes.md#reset-searchable-attributes).
39+
If you'd like to restore your searchable attributes list to this default behavior, [set `searchableAttributes` to an empty array `[]`](/reference/api/searchable_attributes.md#update-searchable-attributes) or use the [reset searchable attributes endpoint](/reference/api/searchable_attributes.md#reset-searchable-attributes).
4040

4141
#### Manual
4242

43-
You may want to make some attributes non-searchable, or change the [attribute ranking order](/learn/core_concepts/relevancy.md#attribute-ranking-order) after documents have been indexed. To do so, simply place the attributes in the desired order and send the updated list using the [update searchable attributes endpoint](/reference/api/searchable_attributes.md#update-searchable-attributes).
43+
You may want to make some attributes non-searchable, or change the [attribute ranking order](/learn/core_concepts/relevancy.md#attribute-ranking-order) after documents have been indexed. To do so, place the attributes in the desired order and send the updated list using the [update searchable attributes endpoint](/reference/api/searchable_attributes.md#update-searchable-attributes).
4444

4545
After manually updating the `searchableAttributes` list, **subsequent new attributes will no longer be automatically added** unless the settings are [reset](/reference/api/searchable_attributes.md#reset-searchable-attributes).
4646

‎learn/cookbooks/aws.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,15 @@ Here you can specify [details of your Instance](https://docs.aws.amazon.com/efs/
4747

4848
![Page titled 'Step 3: Configure Instance Details'. Important: You can launch multiple instances from the same AMI, request Spot instances to take advantage of lower pricing, and assign access management role to the instance.](/aws/04.instance-details.png)
4949

50-
Simply click on **Next: Add Storage** to keep going.
50+
Click **Next: Add Storage** to keep going.
5151

5252
### 5. Storage
5353

5454
Choose the storage **device** and **size** for your Meilisearch instance.
5555

5656
![Page titled 'Step 4: Add Storage'. Text at bottom of screen: Free tier eligible users can get up to 30GB of EBS General Purpose (SSD) or Magnetic storage.](/aws/05.storage.png)
5757

58-
The amount of storage space required can [vary drastically](/learn/advanced/storage.md#measured-disk-usage) depending on the data you plan to index. In this example, we will use 25 GiB, which is more than enough for most small datasets (< 1 million documents). We have the **Volume Type** set to **General Purpose SSD (gp2)**.
58+
The amount of storage space required can [vary drastically](/learn/advanced/storage.md#measured-disk-usage) depending on the data you plan to index. In this example, we will use 25 GiB, which is more than enough for most small datasets (< 1 million documents). We have the **Volume Type** set to **General Purpose SSD (gp2)**.
5959

6060
When you're ready, click on **Next: Add Tags** to continue.
6161

0 commit comments

Comments
 (0)