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, youll learn what Batch Jobs are and how they work in Medusa.
## What are Batch Jobs?
## What are Batch Jobs
Batch Jobs are tasks that can be performed asynchronously and iteratively. They can be [created using the Admin API](https://docs.medusajs.com/api/admin/#tag/Batch-Job/operation/PostBatchJobs), then, once confirmed, they are processed asynchronously.
@@ -56,6 +56,6 @@ If the batch job fails at any point in this flow, its status is changed to `fail
![Flowchart summarizing the batch job's flow from creation to completion](https://i.imgur.com/Qja0kAz.png)
## Whats Next?
## Whats Next
- Learn about the [Batch Jobs events](../subscribers/events-list.md#batch-jobs-events).