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
This commit is contained in:
Shahed Nasser
2022-09-22 13:12:09 +03:00
committed by GitHub
parent d0d789b6d4
commit 6adaf56c73
103 changed files with 2408 additions and 832 deletions
@@ -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.
+4 -4
View File
@@ -1,6 +1,6 @@
# Contentful
In this document, youll learn how to integrate a Medusa server with Contentful to add rich CMS functionalities
In this document, youll 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` youll find 3 variables:
Change to the `medusa-contentful` directory. In `.env` youll 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.