Skip to content

Commit 3d480af

Browse files
maryamsulemani97maryamsulemani97
authored
Merge branch 'master' into remove-code-sample
2 parents 30f4412 + baed4b9 commit 3d480af

19 files changed

+561
-252
lines changed

‎.code-samples.meilisearch.yaml

Lines changed: 291 additions & 245 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

‎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/cookbooks/azure.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ You can deploy a Meilisearch instance via the official [Meilisearch Docker image
2020

2121
When clicking this button, you'll be redirected to the Azure Portal and asked a few questions:
2222

23-
- **Region**: This is the deployment region. You should select a region close to you or your users.
24-
- **Environment**: The name of the environment you want to deploy to, like `dev` (for development) or `prod` (for production). This setting has no effect on the type of resources deployed. It's just for convenience.
25-
- **Application Name**: The name of your application. This name should be **unique across all Azure customers**. The URL where your application is deployed will contain this value.
26-
- **Location**: This the resources location. For reasons out of scope of this documentation, this parameter is different from the _Region_ one. By default, it is set to `eastus`, but you can type any Azure location (like `francecentral`, `westeurope`, or `japaneast`).
27-
- **Meilisearch_apikey**: This will be the [master key](/learn/security/master_api_keys.md) of your Meilisearch instance. While we generate a random key by default, we encourage you to set your own key.
23+
- "Region": This is the deployment region. You should select a region close to you or your users.
24+
- "Environment": The name of the environment you want to deploy to, like `dev` (for development) or `prod` (for production). This setting has no effect on the type of resources deployed. It's just for convenience.
25+
- "Application Name": The name of your application. This name should be **unique across all Azure customers**. The URL where your application is deployed will contain this value.
26+
- "Location": This is the resources' location. For reasons out of scope of this documentation, this parameter is different from the _Region_ one. By default, it is set to `eastus`, but you can type any Azure location (like `francecentral`, `westeurope`, or `japaneast`).
27+
- "`Meilisearch_apikey`": This will be the [master key](/learn/security/master_api_keys.md) of your Meilisearch instance. While we generate a random key by default, we encourage you to set your own key.
2828

2929
Once you have filled in these fields, click the **Review + create** button, and then the **Create** button.
3030

‎learn/getting_started/quick_start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ docker run -it --rm \
5858
-p 7700:7700 \
5959
-e MEILI_MASTER_KEY='MASTER_KEY'\
6060
-v $(pwd)/meili_data:/meili_data \
61-
getmeili/meilisearch:v0.27.1
61+
getmeili/meilisearch:v0.27.1 \
6262
meilisearch --env="development"
6363
```
6464

0 commit comments

Comments
 (0)