Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix linter errors and warnings #2686

Merged
merged 2 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .vale/styles/Vocab/word_list/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,36 @@ AMIs
Brotli
zlib
glibc
gzip
autogenerate
[Vv]ercel
[Uu]pvote
[Uu]pvoting
[Dd]atetime
[Ss]olaris
filterableAttributes
videogame
Maneu
[Ee]nqueues
fontSize
[Ss]ubdocument
[Ss]ubdocuments
Palo
MBs
Yonik
Seeley
Bleve
Hoxie
macOS
SDK
gif
Bardem
LMDB
[Ss]ubscore
Radford
masterKey
[Ii]nstantsearch
GCP
Boolean
GET
POST
4 changes: 2 additions & 2 deletions learn/contributing/contributing_docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,9 @@ We ask the following questions:

Nothing makes us happier than a thoughtful and helpful PR. Your PRs often save us time and effort, and they make the documentation **even stronger**.

Our only major requirement for PR contributions is that the author responds to communication requests within a reasonable timeframe.
Our only major requirement for PR contributions is that the author responds to communication requests within a reasonable time frame.

Once you've opened a PR on this repo, one of our team members will stop by shortly to review it. If your PR is approved, nothing further is required from you. However, **if in seven days you have not responded to a request for further changes or more information, we will consider the PR abandoned and close it**.
Once you've opened a PR in this repository, one of our team members will stop by shortly to review it. If your PR is approved, nothing further is required from you. However, **if in seven days you have not responded to a request for further changes or more information, we will consider the PR abandoned and close it**.

If this happens to you and you think there has been some mistake, please let us know and we will try to rectify the situation.

Expand Down
2 changes: 1 addition & 1 deletion learn/cookbooks/postman_collection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Set the "Token" if needed (set to `masterKey` by default):

Set `url` (set to Meilisearch's local port by default) and `indexUID` (set to `indexUID` by default):

![Setting the "url" to http://localhost:7700/ and "indexUID" to indexUId in the Variables tab.](https://raw.githubusercontent.com/meilisearch/documentation/main/assets/images/postman/set_variables.png)
![Setting the "URL" to http://localhost:7700/ and "indexUID" to indexUId in the Variables tab.](https://raw.githubusercontent.com/meilisearch/documentation/main/assets/images/postman/set_variables.png)

The `url` and `indexUID` variables are used in all the collection routes, like in this one:

Expand Down
4 changes: 2 additions & 2 deletions learn/cookbooks/search_bar_for_docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The Meili team provides and maintains a [scraper tool](https://github.com/meilis

### Configuration file

The scraper tool needs a configuration file to know what content you want to scrape. This is done by providing selectors (for example, the HTML tag).
The scraper tool needs a configuration file to know what content you want to scrape. This is done by providing selectors (for example, the `html` tag).

Here is an example of a basic configuration file:

Expand Down Expand Up @@ -178,7 +178,7 @@ Read more about [Meilisearch security](/learn/security/master_api_keys).

If you don't use VuePress for your documentation, we provide a [front-end SDK](https://github.com/meilisearch/docs-searchbar.js) to integrate a powerful and relevant search bar to any documentation website.

![Docxtemplater search bar updating results for 'html'](https://raw.githubusercontent.com/meilisearch/documentation/main/assets/images/tuto-searchbar-for-docs/docxtemplater-searchbar-demo.gif)
![Docxtemplater search bar updating results for "HTML"](https://raw.githubusercontent.com/meilisearch/documentation/main/assets/images/tuto-searchbar-for-docs/docxtemplater-searchbar-demo.gif)
_[Docxtemplater](https://docxtemplater.com/) search bar demo_

```html
Expand Down
2 changes: 1 addition & 1 deletion learn/deployment/railway.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Click the button below to deploy a Meilisearch instance to Railway quickly.

### Environment Variables

`MEILI_ENV`: by default, this template sets the `MEILI_ENV` environment variable to `production`. If you would like access to the Meilisearch [search preview](/learn/getting_started/search_preview), update `MEILI_ENV` to `development`.
`MEILI_ENV`: by default, this template sets the `MEILI_ENV` environment variable to `production`. If you would like access to the Meilisearch [search preview](/learn/getting_started/search_preview), update `MEILI_ENV` to `development`.

`MEILI_MASTER_KEY`: replace the `MEILI_MASTER_KEY` environment variable with a strong key to secure your Meilisearch instance.

Expand Down
2 changes: 1 addition & 1 deletion learn/inner_workings/known_limitations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ user = 1 OR (user = 2 AND user = 3) OR (user = 4 AND user = 5) OR user = 6

## Maximum task database size

**Limitation:** Meilisearch supports a maximum task dabatase size of 10GiB.
**Limitation:** Meilisearch supports a maximum task database size of 10GiB.

**Explanation:** Depending on your setup, 10GiB should correspond to 5M to 15M tasks. Once the task database contains over 1M entries (roughly 1GiB on average), Meilisearch tries to automatically delete finished tasks while continuing to enqueue new tasks as usual. This ensures the task database does not use an excessive amount of resources. If your database reaches the 10GiB limit, Meilisearch will log a warning indicating the engine is not working properly and refuse to enqueue new tasks.

Expand Down
2 changes: 1 addition & 1 deletion learn/what_is_meilisearch/comparison_to_alternatives.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Unlike Elasticsearch, which is a general search engine designed for large amount

Elasticsearch can sometimes be too slow if you want to provide a full instant search experience. Most of the time, it is significantly slower in returning search results compared to Meilisearch.

Meilisearch is a perfect choice if you need a simple and easy tool to deploy a typo-tolerant search bar that provides prefix searching capability, makes search intuitive for users, and returns results instantly with excellent relevance out of the box.
Meilisearch is a perfect choice if you need a simple and easy tool to deploy a typo-tolerant search bar. It provides prefix searching capability, makes search intuitive for users, and returns results instantly with excellent relevance out of the box.

### Meilisearch vs Algolia

Expand Down
2 changes: 1 addition & 1 deletion learn/what_is_meilisearch/telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ This list is liable to change with every new version of Meilisearch. It's not be
| `system.cores` | Number of cores | 24
| `system.ram_size` | Total RAM capacity. Expressed in `KB` | 16777216
| `system.disk_size` | Total capacity of the largest disk. Expressed in `Bytes` | 1048576000
| `system.server_provider` | Users can tell us on which provider Meilisearch is hosted by filling the `MEILI_SERVER_PROVIDER` environment variable. This is also filled by our cloud deploy scripts, for example, [GCP cloud-config.yaml](https://github.com/meilisearch/cloud-scripts/blob/56a7c2630c1a508e5ad0c0ba1d8cfeb8d2fa9ae0/scripts/providers/gcp/cloud-config.yaml#L33) | gcp
| `system.server_provider` | Users can tell us on which provider Meilisearch is hosted by filling the `MEILI_SERVER_PROVIDER` environment variable. This is also filled by our cloud deploy scripts, for example, [GCP cloud-config.yaml](https://github.com/meilisearch/cloud-scripts/blob/56a7c2630c1a508e5ad0c0ba1d8cfeb8d2fa9ae0/scripts/providers/gcp/cloud-config.yaml#L33) | GCP
| `stats.database_size` | Database size. Expressed in `Bytes` | 2621440
| `stats.indexes_number` | Number of indexes | 2
| `start_since_days` | Number of days since instance was launched | 365
Expand Down
2 changes: 1 addition & 1 deletion reference/api/keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ For security reasons, we do not recommend creating keys that can perform all act
| :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`search`** | Provides access to both [`POST`](/reference/api/search#search-in-an-index-with-post) and [`GET`](/reference/api/search#search-in-an-index-with-get) search endpoints |
| **`documents.add`** | Provides access to the [add documents](/reference/api/documents#add-or-replace-documents) and [update documents](/reference/api/documents#add-or-update-documents) endpoints |
| **`documents.get`** | Provides access to the [get one document](/reference/api/documents#get-one-document), [get documents with POST](/reference/api/documents#get-documents-with-post), and [get documents with GET](/reference/api/documents#get-documents-with-get) endpoints endpoints |
| **`documents.get`** | Provides access to the [get one document](/reference/api/documents#get-one-document), [get documents with POST](/reference/api/documents#get-documents-with-post), and [get documents with GET](/reference/api/documents#get-documents-with-get) endpoints |
| **`documents.delete`** | Provides access to the [delete one document](/reference/api/documents#delete-one-document), [delete all documents](/reference/api/documents#delete-all-documents), [batch delete](/reference/api/documents#delete-documents-by-batch), and [delete by filter](/reference/api/documents#delete-documents-by-filter) endpoints |
| **`indexes.create`** | Provides access to the [create index](/reference/api/indexes#create-an-index) endpoint |
| **`indexes.get`** | Provides access to the [get one index](/reference/api/indexes#get-one-index) and [list all indexes](/reference/api/indexes#list-all-indexes) endpoints. **Non-authorized `indexes` will be omitted from the response** |
Expand Down
2 changes: 1 addition & 1 deletion reference/api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Meilisearch supports the following compression methods:

- `br`: uses the [Brotli](https://en.wikipedia.org/wiki/Brotli) algorithm
- `deflate`: uses the [zlib](https://en.wikipedia.org/wiki/Zlib) structure with the [deflate](https://en.wikipedia.org/wiki/DEFLATE) compression algorithm
- `gzip`: uses the [GZip](https://en.wikipedia.org/wiki/Gzip) algorithm
- `gzip`: uses the [gzip](https://en.wikipedia.org/wiki/Gzip) algorithm

#### Request compression

Expand Down
2 changes: 1 addition & 1 deletion reference/api/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ If an attribute used on `facets` has not been added to the `filterableAttributes
#### `facetStats`

When using the `facets` parameter, any matching documents with facets containing numeric values are displayed in a `facetStats` object. `facetStats` contains the numeric minimum (`min`) and maximum (`max`) values per facet for all documents matching the search query.
If none of the matching documents have a numeric value for a facet, that facet is not included in the `facetStats` object.
If none of the matching documents have a numeric value for a facet, that facet is not included in the `facetStats` object.

#### Example

Expand Down