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
@@ -14,7 +14,7 @@ Through Medusa's flexible plugin system, it is possible to add a search engine t

 ### Medusa Components

-It is required to have a Medusa server installed before starting with this documentation. If not, please follow along with our [quickstart guide](../quickstart/quick-start.md) to get started in minutes.
+It is required to have a Medusa server installed before starting with this documentation. If not, please follow along with the [quickstart guide](../quickstart/quick-start.md) to get started in minutes.

 Furthermore, it’s highly recommended to ensure your Medusa server is configured to work with Redis. As Medusa uses Redis for the event queue internally, configuring Redis ensures that the search indices in Algolia are updated whenever products on the Medusa server are updated. You can follow [this documentation to install Redis](../tutorial/0-set-up-your-development-environment.mdx#redis) and then [configure it on your Medusa server](../usage/configurations.md#redis).

@@ -227,13 +227,13 @@ export const query = graphql`
 To test this out, run your Medusa server by running this command in its directory:

 ```bash
-npm start
+npm run start
 ```

 Then run the Gatsby storefront by running this command in its directory:

 ```bash
-npm start
+npm run start
 ```

 This runs the Gatsby storefront on `localhost:8000`. Go to the storefront in your browser and open the About page. You should see the Rich Text content you added.
@@ -1,6 +1,6 @@
 # Contentful

-In this document, you’ll learn how to integrate a Medusa server with Contentful to add rich CMS functionalities
+In this document, you’ll learn how to integrate a Medusa server with Contentful to add rich Content Management System (CMS) functionalities

 ## Overview

@@ -36,7 +36,7 @@ This installs a new Medusa server in the directory `medusa-contentful`.

 ### Add Contentful Environment Variables

-Change to the `medusa-contentful` directory. In `.env` you’ll find 3 variables:
+Change to the `medusa-contentful` directory. In `.env` you’ll find three variables:

 ```bash
 CONTENTFUL_SPACE_ID=
@@ -172,7 +172,7 @@ npm run seed
 To start the server run the following command:

 ```bash
-npm start
+npm run start
 ```

 If you seeded the database with demo data, you should see that events related to the products are triggered.
@@ -257,7 +257,7 @@ You should find the field "Content Delivery API - access token”. Copy its valu
 Make sure the Medusa server is still running. Then, start the storefront:

 ```bash
-npm start
+npm run start
 ```

 This starts the storefront at `localhost:8000`. Open it in your browser and you should see on the homepage the Featured Product section with the products you chose on Contentful.
@@ -10,19 +10,19 @@ By integrating Mailchimp with Medusa, customers will be able to subscribe from M

 :::note

-This plugin is only used to allow your customers to subscribe but does not actually do any email sending. If you want to send emails to customers based on specific events, for example, when an order is placed, you should check out our [SendGrid plugin](./sendgrid.mdx) instead.
+This plugin is only used to allow your customers to subscribe but does not actually do any email sending. If you want to send emails to customers based on specific events, for example, when an order is placed, you should check out the [SendGrid plugin](./sendgrid.mdx) instead.

 :::

 ## Prerequisites

-Before going further with this guide make sure you have a Medusa server set up. You can follow our [Quickstart guide](https://docs.medusajs.com/quickstart/quick-start).
+Before going further with this guide make sure you have a Medusa server set up. You can follow the [Quickstart guide](https://docs.medusajs.com/quickstart/quick-start).

 You also need a Mailchimp account, so please [create one](https://mailchimp.com/signup) before you start.

 ## Obtain Mailchimp Keys

-To integrate the plugin into Medusa you need 2 keys: The API Key and the Newsletter list or Audience ID. The API Key acts as a credential for your account, whereas the Newsletter list ID determines which audience should the subscribed customers be added to.
+To integrate the plugin into Medusa you need two keys: The API Key and the Newsletter list or Audience ID. The API Key acts as a credential for your account, whereas the Newsletter list ID determines which audience should the subscribed customers be added to.

 You can follow [this guide](https://mailchimp.com/help/about-api-keys/#Find_or_generate_your_API_key) from Mailchimp’s documentation to obtain an API Key.

@@ -14,7 +14,7 @@ Through Medusa's flexible plugin system, it is possible to add a search engine t

 ### Medusa Components

-It is required to have a Medusa server installed before starting with this documentation. If not, please follow along with our [quickstart guide](../quickstart/quick-start.md) to get started in minutes.
+It is required to have a Medusa server installed before starting with this documentation. If not, please follow along with the [quickstart guide](../quickstart/quick-start.md) to get started in minutes.

 Furthermore, it’s highly recommended to ensure your Medusa server is configured to work with Redis. As Medusa uses Redis for the event queue internally, configuring Redis ensures that the search indices in MeiliSearch are updated whenever products on the Medusa server are updated. You can follow [this documentation to install Redis](../tutorial/0-set-up-your-development-environment.mdx#redis) and then [configure it on your Medusa server](../usage/configurations.md#redis).

@@ -18,9 +18,9 @@ In addition, you need to configure a webhook listener on your PayPal Developer D

 Webhooks are used in scenarios where the customer might leave the page during the authorization and before the checkout flow is fully complete. It will then create the order or swap after the payment is authorized if they weren’t created

-Additionally, you need a Medusa server installed and set up. If not, you can follow our [quickstart guide](https://docs.medusajs.com/quickstart/quick-start) to get started.
+Additionally, you need a Medusa server installed and set up. If not, you can follow the [quickstart guide](https://docs.medusajs.com/quickstart/quick-start) to get started.

-You also need [Medusa Admin](../admin/quickstart.md) installed to enable PayPal as a payment provider. You can alternatively use our [REST APIs](https://docs.medusajs.com/api/admin).
+You also need [Medusa Admin](../admin/quickstart.md) installed to enable PayPal as a payment provider. You can alternatively use the [REST APIs](https://docs.medusajs.com/api/admin).

 ## Medusa Server

@@ -32,7 +32,7 @@ The Create Bucket form will open. In the General Configuration section enter a n

 ![Enter bucket name and choose region in the General Configuration section](https://i.imgur.com/wlxUU8I.png)

-Next, in the Object Ownership section, choose ACLs enabled. Then, 2 radio buttons will show below it. Choose Bucket owner preferred.
+Next, in the Object Ownership section, choose ACLs enabled. Then, two radio buttons will show below it. Choose Bucket owner preferred.

 ![In the Object Ownership section choose ACLs enabled, then choose Bucket owner preferred for the Object ownership field](https://i.imgur.com/ChUXQPt.png)

@@ -119,7 +119,7 @@ const plugins = [
 Run your server with the following command:

 ```bash npm2yarn
-npm start
+npm run start
 ```

 Then, try triggering one of the [mentioned events earlier in this document](#events-that-the-segment-plugin-tracks). For example, you can place an order either using the [REST APIs](https://docs.medusajs.com/api/store) or using the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts.
@@ -22,7 +22,7 @@ By integrating SendGrid with Medusa, you’ll be sending email notifications to

 ## Prerequisites

-Before going further with this guide make sure you have a Medusa server set up. You can follow our [Quickstart guide](../quickstart/quick-start.md).
+Before going further with this guide make sure you have a Medusa server set up. You can follow the [Quickstart guide](../quickstart/quick-start.md).

 You also must have [Redis configured on your Medusa server](/tutorial/set-up-your-development-environment#redis). Sending emails is done through Subscribers, which uses Redis as the event queue. If you don’t set up Redis, the plugin will not send emails.

@@ -42,7 +42,7 @@ If you choose to give the API Key restricted access, make sure to at least give

 :::

-Once you create the API key, the key will be shown for one time only. So, make sure to copy and save it somewhere for later usage.
+Once you create the API key, the key will be shown for one time only. Make sure to copy and save it somewhere for later usage.

 ### Email Templates

@@ -3953,7 +3953,7 @@ To test it out, perform an action that would trigger one of the emails being sen

 :::tip

-If you don’t have a storefront installed, check out our [Gatsby](../starters/gatsby-medusa-starter.md) or [Next.js](../starters/nextjs-medusa-starter.md) starters to create a storefront in minutes.
+If you don’t have a storefront installed, check out the [Gatsby](../starters/gatsby-medusa-starter.md) or [Next.js](../starters/nextjs-medusa-starter.md) starters to create a storefront in minutes.

 :::

@@ -1,6 +1,6 @@
 # Strapi

-In this document, you’ll learn how to integrate Strapi with Medusa to add rich CMS functionalities.
+In this document, you’ll learn how to integrate Strapi with Medusa to add rich Content Management System (CMS) functionalities.

 :::info

@@ -4,7 +4,7 @@ This document guides you through setting up Stripe payments in your Medusa serve

 ## Video Guide

-You can also follow our video guide to learn how the setup works:
+You can also follow this video guide to learn how the setup works:

 <div>
  <video width="100%" height="100%" playsinline autoplay muted controls>
@@ -26,7 +26,7 @@ Before you proceed with this guide, make sure you create a [Stripe account](http

 This section guides you over the steps necessary to add Stripe as a payment provider to your Medusa server.

-If you don’t have a Medusa server installed yet, you must follow our [quickstart guide](../quickstart/quick-start) first.
+If you don’t have a Medusa server installed yet, you must follow the [quickstart guide](../quickstart/quick-start) first.

 ### Install the Stripe Plugin

@@ -61,7 +61,7 @@ You might find that this code is already available but commented out. You can pr

 :::

-The Stripe plugin uses 2 configuration options. The `api_key` is essential to both your development and production environments. As for the `webhook_secret`, it’s essential for your production environment. So, if you’re only using Stripe for development you can skip adding the value for this option at the moment.
+The Stripe plugin uses two configuration options. The `api_key` is essential to both your development and production environments. As for the `webhook_secret`, it’s essential for your production environment. So, if you’re only using Stripe for development you can skip adding the value for this option at the moment.

 ### Retrieve Stripe's Keys

@@ -16,13 +16,13 @@ This plugin only gives you access to the Twilio SMS API but does not implement s

 ## Prerequisites

-Before going further with this guide make sure you have a Medusa server set up. You can follow our [Quickstart guide](../quickstart/quick-start.md) if you don’t.
+Before going further with this guide make sure you have a Medusa server set up. You can follow the [Quickstart guide](../quickstart/quick-start.md) if you don’t.

 You also must have a [Twilio account created](https://www.twilio.com/sms) so if you don’t already please go ahead and create one.

 ## Retrieve Credentials

-For the [Twilio SMS plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-twilio-sms), you need three credentials from your Twilio account: Account SID, Auth Token, and a Twilio phone number to send from. You can find these 3 from your [Twilio Console’s homepage](https://console.twilio.com).
+For the [Twilio SMS plugin](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-twilio-sms), you need three credentials from your Twilio account: Account SID, Auth Token, and a Twilio phone number to send from. You can find these three from your [Twilio Console’s homepage](https://console.twilio.com).

 ## Install Plugin

@@ -110,7 +110,7 @@ If you create an order now on your storefront, you should receive a message from

 :::tip

-If you don’t have a storefront set up yet, you can install one of our [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts.
+If you don’t have a storefront set up yet, you can install one of the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefronts.

 :::