docs: integrate Vale for documentation linting (#2242)

* added value rules * resolved errors raised by vale * added github action * fixes to github action * added details in contribution guidelines * added rule for numbers * limited checks to errors
2022-09-22 13:12:09 +03:00
parent d0d789b6d4
commit 6adaf56c73
103 changed files with 2408 additions and 832 deletions
@@ -98,7 +98,7 @@ In the form that shows, keep all fields the same and click on the “Show advanc

 ![Show advanced Button](https://i.imgur.com/nUdwRbq.png)

-Under the “Advanced build settings” section click on the “New variable” button. This will show 2 inputs for the key and value of the environment variable.
+Under the “Advanced build settings” section click on the “New variable” button. This will show two inputs for the key and value of the environment variable.

 For the first field enter the key `GATSBY_MEDUSA_BACKEND_URL` and for the value enter the URL of your Medusa server.

@@ -128,7 +128,7 @@ If you click on it, you’ll be redirected to the deployed admin website.

 :::note

-Before you can use Medusa Admin, you must add the URL as an environment variable on your deployed Medusa server. Follow along in the [Configure CORS on the Medusa Server](#configure-cors-variable-on-the-medusa-server) section.
+Before you can use Medusa Admin, you must add the URL as an environment variable on your deployed Medusa server. Follow along in the [Configure Cross-Origin Resource Sharing (CORS) on the Medusa Server](#configure-cors-variable-on-the-medusa-server) section.

 :::

@@ -168,7 +168,7 @@ In your terminal, run the following command:
 netlify init
 ```

-You’ll have to follow 5 steps for the initialization:
+You’ll have to follow five steps for the initialization:

 ##### **Step 1: Create Netlify Website**

@@ -8,7 +8,7 @@ DigitalOcean is a reliable hosting provider that provides different ways to host

 ### Medusa Server

-It is assumed that you already have a Medusa server installed locally. If you don’t, please follow our [quickstart guide](../../quickstart/quick-start.md).
+It is assumed that you already have a Medusa server installed locally. If you don’t, please follow the [quickstart guide](../../quickstart/quick-start.md).

 Furthermore, your Medusa server should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Server documentation](../../usage/configurations.md) to learn how to do that.

@@ -163,7 +163,7 @@ Once you’re done, click Next to move on to the next step.

 In this section, you’ll add environment variables that are essential to your Medusa server.

-You should see 2 ways to add environment variables: Global or specific to the Web Service.
+You should see two ways to add environment variables: Global or specific to the Web Service.

 ![Global environment variables and web service environment variables](https://i.imgur.com/VOYykPT.png)

@@ -263,7 +263,7 @@ Make sure to replace `<EMAIL>` and `<PASSWORD>` with the credentials you want to

 ## Add Environment Variables

-You’ll likely need to add environment variables later such as Admin CORS and Store CORS variables. 
+You’ll likely need to add environment variables later such as Admin Cross-Origin Resource Sharing (CORS) and Store CORS variables.

 To add environment variables, on the App’s page click on Settings and choose the Web Service component.

@@ -20,7 +20,7 @@ Alternatively, you can use this button to deploy the Medusa server to Heroku dir

 ### Medusa Server

-It is assumed that you already have a Medusa server installed locally. If you don’t, please follow our [quickstart guide](../../quickstart/quick-start.md).
+It is assumed that you already have a Medusa server installed locally. If you don’t, please follow the [quickstart guide](../../quickstart/quick-start.md).

 Furthermore, your Medusa server should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Server documentation](../../usage/configurations.md) to learn how to do that.

@@ -135,7 +135,7 @@ heroku buildpacks:set heroku/nodejs

 Upstash adds the Redis URL under the environment variable `UPSTASH_REDIS_URL`. However, Medusa looks for the `REDIS_URL` environment variable when initializing the connection with Redis.

-So, retrieve the value of `UPSTASH_REDIS_URL` with the following command:
+Retrieve the value of `UPSTASH_REDIS_URL` with the following command:

 ```bash
 heroku config:get UPSTASH_REDIS_URL
@@ -153,7 +153,7 @@ Where `<YOUR_REDIS_URL>` is the value you received from the previous command.

 #### Configure the PostgreSQL Database URL

-If you're using the Heroku PostgreSQL Add-on, it should configure the environment variable `DATABASE_URL`. So, you don't need to perform any additional actions.
+If you're using the Heroku PostgreSQL Add-on, it should configure the environment variable `DATABASE_URL`. In that case, you don't need to perform any additional actions.

 However, if you use another add-on, make sure to set the environment variable `DATABASE_URL` to the PostgreSQL Database URL.

@@ -270,7 +270,7 @@ Where `<APP_NAME>` is the name of your Heroku app, and `<EMAIL>` and `<PASSWORD>

 ## Add Environment Variables

-You’ll likely need to add environment variables later such as Admin CORS and Store CORS variables.
+You’ll likely need to add environment variables later such as Admin Cross-Origin Resource Sharing (CORS) and Store CORS variables.

 To set or change an environment variable's value, you can use the following command:

@@ -2,7 +2,7 @@

 In this document, you'll learn how to deploy your Medusa server on Qovery with the help of Terraform. 

-[Qovery](https://www.qovery.com/) is a Continuous Deployment Platform that provides you with the developer experience of Heroku on top of your cloud provider (e.g. AWS, DigitalOcean).
+[Qovery](https://www.qovery.com/) is a Continuous Deployment Platform that provides you with the developer experience of Heroku on top of your cloud provider (For example, AWS, DigitalOcean).

 [Terraform](https://www.terraform.io/) is an open source infrastructure as code software (IaC) tool that allows you to easily deploy apps like Medusa and the resources it needs to Qovery using a single script.

@@ -16,7 +16,7 @@ This tutorial explains how to deploy Medusa to a Qovery organization with an AWS

 ### Medusa Server

-It is assumed that you already have a Medusa server installed locally. If you don’t, please follow our [quickstart guide](../../quickstart/quick-start.md).
+It is assumed that you already have a Medusa server installed locally. If you don’t, please follow the [quickstart guide](../../quickstart/quick-start.md).

 Furthermore, your Medusa server should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Server documentation](../../usage/configurations.md) to learn how to do that.

@@ -240,7 +240,7 @@ Here’s an explanation of each of the variables and how to retrieve their varia
 - `qovery_create_cluster`: A boolean value indicating whether a new cluster should be created or not. If you already have a cluster that you want to use, you can set the value to `false` and set the value of `qovery_cluster_id`. Otherwise, set the value to `true` and set the values of `aws_access_key_id`, `aws_secret_access_key`, and `aws_region`.
 - `qovery_cluster_id`: The ID of the existing cluster to use (if `qovery_create_cluster` is set to `false`). You can use [Qovery’s REST API](https://api-doc.qovery.com/#tag/Clusters/operation/listOrganizationCluster) to retrieve the cluster ID. You can use the token you generated earlier for the Bearer authorization token as explained [here](https://hub.qovery.com/docs/using-qovery/interface/cli/#generate-api-token).
 - `aws_access_key_id`, `aws_secret_access_key`, and `aws_region`: The credentials used to create the cluster (if `qovery_create_cluster` is set to `true`). You can refer to [this guide](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys) to learn how to retrieve the `aws_access_key_id` and `aws_secret_access_key`.
- `medusa_jwt_secret`: The value of the JWT Secret on your Medusa server. It’s recommended to use a strong randomly generated string.
+- `medusa_jwt_secret`: The value of the JSON Web Token (JWT) Secret on your Medusa server. It’s recommended to use a strong randomly generated string.
 - `medusa_cookie_secret`: The value of the Cookie Secret on your Medusa server. It’s recommended to use a strong randomly generated string.
 - `git_url`: The URL of the Git repository you created earlier. Make sure it ends with `.git`.
 - `git_branch`: The branch to use in the GitHub repo. By default it’s `master`.
@@ -461,7 +461,7 @@ terraform apply

 You’ll be asked to confirm creating all the necessary resources in Qovery. Enter `yes` and the deployment will start.

-The deployment can take up to 30 minutes to finish. You’ll be able to track its status both in your terminal and in the [Qovery Console](https://console.qovery.com/).
+The deployment can take up to thirty minutes to finish. You’ll be able to track its status both in your terminal and in the [Qovery Console](https://console.qovery.com/).

 :::tip

@@ -496,7 +496,7 @@ medusa user --email <EMAIL> --password <PASSWORD>

 ## Add Environment Variables

-You’ll likely need to add environment variables later such as Admin CORS and Store CORS variables.
+You’ll likely need to add environment variables later such as Admin Cross-Origin Resource Sharing (CORS) and Store CORS variables.

 To add environment variables, in your [Qovery Console](https://console.qovery.com/) go to the Medusa app and choose Environment Variables from the sidebar. You can add environment variables here at any point later on.

@@ -98,7 +98,7 @@ In the form that shows, keep all fields the same and click on the “Show advanc

 ![Show advanced Button](https://i.imgur.com/nUdwRbq.png)

-Under the “Advanced build settings” section click on the “New variable” button. This will show 2 inputs for the key and value of the environment variable.
+Under the “Advanced build settings” section click on the “New variable” button. This will show two inputs for the key and value of the environment variable.

 For the first field enter the key `GATSBY_MEDUSA_BACKEND_URL` and for the value enter the URL of your Medusa server.

@@ -146,7 +146,7 @@ If you click on it, you’ll be redirected to the deployed storefront website.

 :::caution

-At this point, you will face errors related to CORS while using the storefront. Before you start using the storefront, follow along the [Configure CORS on the Medusa Server section](#configure-cors-variable-on-the-medusa-server).
+At this point, you will face errors related to Cross-Origin Resource Sharing (CORS) while using the storefront. Before you start using the storefront, follow along the [Configure CORS on the Medusa Server section](#configure-cors-variable-on-the-medusa-server).

 :::

@@ -186,7 +186,7 @@ In your terminal, run the following command:
 netlify init
 ```

-You’ll have to follow 5 steps for the initialization:
+You’ll have to follow five steps for the initialization:

 ##### Step 1: Create Netlify Website