Merge #1721

1721: add commas after `e.g.` and `i.e.` r=maryamsulemani97 a=maryamsulemani97



Co-authored-by: Maryam Sulemani <[email protected]>
Co-authored-by: Maryam <[email protected]>

Author: bors[bot]

learn/advanced/datatypes.md

@@ -61,7 +61,7 @@ You can also create [filters](/learn/advanced/filtering_and_faceted_search.md).
 
 ## Boolean
 
-A Boolean value, which is either `true` or `false`, is received and converted to a lowercase human-readable text (i.e. `true` and `false`). Booleans can be searched as they are converted to strings.
+A Boolean value, which is either `true` or `false`, is received and converted to a lowercase human-readable text (i.e., `true` and `false`). Booleans can be searched as they are converted to strings.
 
 ## `null`
 

learn/advanced/snapshots.md

@@ -1,6 +1,6 @@
 # Snapshots
 
-A snapshot is an exact copy of the database (i.e. the `data.ms` folder) at the time the snapshot was created. Besides compression, snapshots do not go through any processing. They can be thought of as "pre-compiled copies".
+A snapshot is an exact copy of the database (i.e., the `data.ms` folder) at the time the snapshot was created. Besides compression, snapshots do not go through any processing. They can be thought of as "pre-compiled copies".
 
 Using this feature, it is possible to schedule snapshot creation at custom intervals and use existing snapshots to restore Meilisearch.
 
@@ -50,7 +50,7 @@ meilisearch --import-snapshot mySnapShots/data.ms.snapshot
 
 Take note that whenever you launch Meilisearch from a snapshot, it will **stop processing and throw an error** if it encounters either of the two following situations:
 
-1. A database already exists (i.e. you have a non-empty `data.ms` folder in the same directory as your Meilisearch binary)
+1. A database already exists (i.e., you have a non-empty `data.ms` folder in the same directory as your Meilisearch binary)
 2. No snapshot is found at the given path
 
 In both cases, **this behavior is [configurable](/learn/configuration/instance_options.md#ignore-missing-snapshot)**.

learn/advanced/tokenization.md

@@ -10,7 +10,7 @@ This allows Meilisearch to function in several different languages with zero set
 
 ![Chart illustrating the architecture of Meilisearch's tokenizer](https://user-images.githubusercontent.com/6482087/102896344-8560d200-4466-11eb-8cfe-b4ae8741093b.jpg)
 
-When you add documents to a Meilisearch index, the tokenization process is handled by an abstract interface called an **analyzer**. The analyzer is responsible for determining the primary language of each field based on the scripts (e.g. Latin alphabet, Chinese hanzi, etc.) that are present there. Then, it applies the corresponding **pipeline** to each field.
+When you add documents to a Meilisearch index, the tokenization process is handled by an abstract interface called an **analyzer**. The analyzer is responsible for determining the primary language of each field based on the scripts (e.g., Latin alphabet, Chinese hanzi, etc.) that are present there. Then, it applies the corresponding **pipeline** to each field.
 
 We can break down the tokenization process like so:
 

learn/advanced/updating.md

@@ -10,7 +10,7 @@ If you have already **installed the latest version and manually indexed your dat
 
 ## Verify your database version
 
-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:
+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:
 
 ```bash
 ./meilisearch --master-key="MASTER_KEY"
@@ -37,7 +37,7 @@ The response should look something like this:
 
 If you get the error `Cannot open database, expected Meilisearch engine version: 0.X.X, current engine version 0.Y.Y`, your database is not compatible with the currently installed Meilisearch version.
 
-In this case, you need to **download the compatible version now** (i.e. `0.X.X` in the above error message) so that you can access and export your database.
+In this case, you need to **download the compatible version now** (i.e., `0.X.X` in the above error message) so that you can access and export your database.
 
 :::: tabs
 

learn/configuration/instance_options.md

@@ -42,7 +42,7 @@ In the previous example, `./meilisearch` is the command that launches a Meilisea
 
 Environment variables for command-line flags accept `n`, `no`, `f`, `false`, `off`, and `0` as `false`. An absent environment variable will also be considered as `false`. Any other value is considered `true`.
 
-Environment variables are always identical to the corresponding command-line option, but prepended with `MEILI_` and written in all uppercase. **Some options (e.g. `--import-snapshots`) are not available as environment variables.**
+Environment variables are always identical to the corresponding command-line option, but prepended with `MEILI_` and written in all uppercase. **Some options (e.g., `--import-snapshots`) are not available as environment variables.**
 
 ## All instance options
 

learn/configuration/typo_tolerance.md

@@ -1,6 +1,6 @@
 # Typo tolerance
 
-Typo tolerance helps users find relevant results even when their search queries contain spelling mistakes or typos, e.g. typing `phnoe` instead of `phone`. You can [configure the typo tolerance feature for each index](/reference/api/typo_tolerance.md#update-typo-tolerance).
+Typo tolerance helps users find relevant results even when their search queries contain spelling mistakes or typos, e.g., typing `phnoe` instead of `phone`. You can [configure the typo tolerance feature for each index](/reference/api/typo_tolerance.md#update-typo-tolerance).
 
 ## Configuring typo tolerance
 

learn/contributing/contributing_to_docs.md

@@ -19,7 +19,7 @@ On the Meilisearch documentation team, [GitHub Issues](https://github.com/meilis
 
 - A detailed bug report
 - A request for a new technical feature (e.g. dark mode, versioning, etc.)
-- A request for new content (e.g. a tutorial, guide, or explanation)
+- A request for new content (e.g., a tutorial, guide, or explanation)
 - A helpful suggestion for the future of the documentation
 
 We love issues at Meilisearch, because they help us do our jobs better. Nine times out of ten, the most useful contribution is a simple GitHub issue that points out a problem and proposes a solution.
@@ -61,7 +61,7 @@ All you need to continue is a [GitHub account](https://github.com).
 1. On the documentation page you'd like to edit, scroll to the bottom and click **"Edit this page"** on the left. This will take you to GitHub.
 2. If you're not already signed in, do so now. You may be prompted to create a [fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)—if so, do it.
 3. Use GitHub's text editor to make the change you want.
-4. Scroll down to where it says `Propose changes`. In the first text box, write a short description (e.g. "Fix typo"). In the second text box, write a longer description of your changes if necessary.
+4. Scroll down to where it says `Propose changes`. In the first text box, write a short description (e.g., "Fix typo"). In the second text box, write a longer description of your changes if necessary.
 5. Click `Propose changes` to continue. You should see a page that says `Comparing changes`. This screen is prompting you to create a pull request.
 6. Make sure the base repository is `meilisearch/documentation` and the base is `master`. Don't worry about the other two boxes—they automatically target the changes you just made.
 7. Below, you can see the changes you made compared to the master branch (what's currently published on docs.meilisearch.com). When you're ready, click `Create pull request`.

learn/cookbooks/koyeb.md

@@ -30,7 +30,7 @@ Using a master key is optional but strongly recommended when running in producti
 
 ### Test Meilisearch
 
-Copy the public URL (e.g. `https://meili-myorg.koyeb.app`) from the [Koyeb control panel](https://app.koyeb.com) and paste it in your browser.
+Copy the public URL (e.g., `https://meili-myorg.koyeb.app`) from the [Koyeb control panel](https://app.koyeb.com) and paste it in your browser.
 
 You should land on the Meilisearch [search preview](/learn/what_is_meilisearch/search_preview.md), where you are asked to enter your master key.
 

learn/cookbooks/qovery.md

@@ -25,7 +25,7 @@ Visit the [Qovery dashboard](https://start.qovery.com) to create an account if y
 
 ### 3. Create a new environment
 
-* Click on **Create environment** and give it a name (e.g. staging, production).
+* Click on **Create environment** and give it a name (e.g., staging, production).
 
 !["Create environment" button](https://hub.qovery.com/img/heroku/heroku-3.png)
 

learn/cookbooks/search_bar_for_docs.md

@@ -40,7 +40,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 (e.g. the HTML tag).
+The scraper tool needs a configuration file to know what content you want to scrape. This is done by providing selectors (e.g., the HTML tag).
 
 Here is an example of a basic configuration file:
 

learn/core_concepts/documents.md

@@ -84,7 +84,7 @@ As an example, let's say you are creating an index that contains information abo
 In the above example:
 
 - `"id"`, `"title"`, `"genres"`, `"release-year"`, and `"cast"` are attributes
-- Each attribute is associated with a value, e.g. `"Kung Fu Panda"` is the value of `"title"`
+- Each attribute is associated with a value, e.g., `"Kung Fu Panda"` is the value of `"title"`
 - The document contains a field with the primary key attribute and a unique document id as its value: `"id": "1564saqw12ss"`
 
 #### NDJSON

learn/experimental/auto-batching.md

@@ -25,7 +25,7 @@ To enable auto-batching, start Meilisearch while supplying the `--enable-auto-ba
 For document addition requests to be added to the same batch, they need to:
 
 - Target the same index
-- Have the same update method (e.g. [POST](/reference/api/documents.md#add-or-replace-documents) or [PUT](/reference/api/documents.md#add-or-update-documents))
+- Have the same update method (i.e., [POST](/reference/api/documents.md#add-or-replace-documents) or [PUT](/reference/api/documents.md#add-or-update-documents))
 - Be immediately consecutive
 
 By default, **auto-batching will not delay processing a request in order to batch multiple requests together.** If it can process the request immediately, it will. [This behavior can be altered using a command-line option](#customization-options).

learn/getting_started/quick_start.md

@@ -2,7 +2,7 @@
 
 This quick start will walk you through setting up Meilisearch, adding documents, performing your first search, using the search preview, adding a search bar, and securing your instance.
 
-All that is required is a [command line](https://www.learnenough.com/command-line-tutorial#sec-running_a_terminal) for installation, and some way to interact with Meilisearch afterwards (e.g. [cURL](https://curl.se) or one of our [SDKs](/learn/what_is_meilisearch/sdks.md)).
+All that is required is a [command line](https://www.learnenough.com/command-line-tutorial#sec-running_a_terminal) for installation, and some way to interact with Meilisearch afterwards (e.g., [cURL](https://curl.se) or one of our [SDKs](/learn/what_is_meilisearch/sdks.md)).
 
 Let's get started!
 

learn/what_is_meilisearch/contact.md

@@ -14,6 +14,6 @@ We think chat and forum discussions are [highly complementary](https://blog.disc
 
 ## GitHub issues 🔩
 
-Bug reports should be added as issues in the corresponding repository, e.g. [meilisearch](https://github.com/meilisearch/meilisearch/issues), [meilisearch/documentation](https://github.com/meilisearch/documentation/issues) and so forth.
+Bug reports should be added as issues in the corresponding repository, e.g., [meilisearch](https://github.com/meilisearch/meilisearch/issues), [meilisearch/documentation](https://github.com/meilisearch/documentation/issues) and so forth.
 
 _Any suggestion or feedback is highly appreciated. Thank you for your support!_

learn/what_is_meilisearch/telemetry.md

@@ -132,7 +132,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, e.g. [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, e.g., [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

reference/api/displayed_attributes.md

@@ -42,7 +42,7 @@ List the settings.
 
 Update the [displayed attributes](/learn/configuration/settings.md#displayed-attributes) of an index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
 
-If an attribute contains an object, you can use dot notation to specify one or more of its keys, e.g. `"displayedAttributes": ["release_date.year"]`.
+If an attribute contains an object, you can use dot notation to specify one or more of its keys, e.g., `"displayedAttributes": ["release_date.year"]`.
 
 ::: note
 `displayedAttributes` only impacts search results. It has no effect on other methods of retrieving or copying documents, such as the [GET documents endpoint](/reference/api/documents.md#get-documents), [dumps](/learn/advanced/dumps.md), or [snapshots](/learn/advanced/snapshots.md).

reference/api/distinct_attribute.md

@@ -34,7 +34,7 @@ Get the [distinct attribute](/learn/configuration/settings.md#distinct-attribute
 
 Update the [distinct attribute](/learn/configuration/settings.md#distinct-attribute) field of an index. This will re-index all documents in the index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
 
-If an attribute contains an object, you can use dot notation to set one or more of its keys as a value for this setting, e.g. `"distinctAttribute": "product.skuid"`.
+If an attribute contains an object, you can use dot notation to set one or more of its keys as a value for this setting, e.g., `"distinctAttribute": "product.skuid"`.
 
 #### Body
 

reference/api/search.md

@@ -495,9 +495,9 @@ You will get the following response with the **cropped text in the `_formatted`
 
 Configures the total number of words to appear in the cropped value when using [`attributesToCrop`](#attributes-to-crop). If `attributesToCrop` is not configured, `cropLength` has no effect on the returned results.
 
-Query terms are counted as part of the cropped value length. If `cropLength` is set to `2` and you search for one term (e.g. `shifu`), the cropped field will contain two words in total (e.g. `"…Shifu informs…"`).
+Query terms are counted as part of the cropped value length. If `cropLength` is set to `2` and you search for one term (e.g., `shifu`), the cropped field will contain two words in total (e.g., `"…Shifu informs…"`).
 
-Stop words are also counted against this number. If `cropLength` is set to `2` and you search for one term (e.g. `grinch`), the cropped result may contain a stop word (e.g. `"…the Grinch…"`).
+Stop words are also counted against this number. If `cropLength` is set to `2` and you search for one term (e.g., `grinch`), the cropped result may contain a stop word (e.g., `"…the Grinch…"`).
 
 If `attributesToCrop` uses the `attributeName:number` syntax to specify a custom crop length for an attribute, that value has priority over `cropLength`.
 

resources/faq.md

@@ -215,7 +215,7 @@ See our [contact page](/learn/what_is_meilisearch/contact.md).
 
 ## I have just updated Meilisearch, and I am getting an error: "Cannot open database, expected Meilisearch engine version..."
 
-Until our first stable release (v1.0), Meilisearch minor versions are not compatible with each other, i.e. **every new version is considered breaking** with the small exception of bug-fixing patches. To fix this error, simply delete your database folder (`data.ms` by default) and re-index your documents with the current-version engine. See [updating Meilisearch](/learn/advanced/updating.md) for more information.
+Until our first stable release (v1.0), Meilisearch minor versions are not compatible with each other, i.e., **every new version is considered breaking** with the small exception of bug-fixing patches. To fix this error, simply delete your database folder (`data.ms` by default) and re-index your documents with the current-version engine. See [updating Meilisearch](/learn/advanced/updating.md) for more information.
 
 ## What are the recommended requirements for hosting a Meilisearch instance?