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
@@ -2,7 +2,7 @@
In this document, you'll learn what Subscribers are in Medusa.
## What are Events?
## What are Events
In Medusa, there are events that are emitted when a certain action occurs. For example, if a customer places an order, the `order.placed` event is emitted with the order data.
@@ -10,7 +10,7 @@ The purpose of these events is to allow other parts of the platform, or third-pa
Medusa's queuing and events system is handled by Redis. So, you must have [Redis configured](../../../tutorial/0-set-up-your-development-environment.mdx#redis) on your server to use subscribers.
## What are Subscribers?
## What are Subscribers
Subscribers register handlers for an events and allows you to perform an action when that event occurs. For example, if you want to send your customer an email when they place an order, then you can listen to the `order.placed` event and send the email when the event is emitted.