docs: rename provider module to module provider (#7869)

* docs: rename provider module to module provider

* fix vale rule

* vale fixes
This commit is contained in:
Shahed Nasser
2024-07-01 10:21:19 +03:00
committed by GitHub
parent 2833e3c4d0
commit 1842cd33cf
28 changed files with 117 additions and 117 deletions
@@ -1,7 +1,7 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `Notification Provider Modules`,
title: `Notification Module Providers`,
}
# {metadata.title}
@@ -12,19 +12,19 @@ You can resolve the Notification Module and send notifications in API routes, su
---
## What is a Notification Provider Module?
## What is a Notification Module Provider?
A notification provider module implements the logic of sending the notification. It either integrates a third-party service or uses custom logic to send the notification.
A notification module provider implements the logic of sending the notification. It either integrates a third-party service or uses custom logic to send the notification.
By default, Medusa uses the Local Notification Module which only simulates sending the notification by logging a message in the terminal.
Medusa provides other Notification Modules that actually send notifications, such as the SendGrid Notification Provider Module.
Medusa provides other Notification Modules that actually send notifications, such as the SendGrid Notification Module Provider.
<ChildDocs type="item" hideItems={["Guides"]} onlyTopLevel={true} />
---
## Notification Provider Module Channels
## Notification Module Provider Channels
When you send a notification, you specify the channel to send it through, such as `email` or `sms`. Each provider defined in the Notification Module's `providers` option has a `channels` option specifying which channels it can be used in. Only one provider can be setup for each channel.
@@ -65,6 +65,6 @@ The `channels` option is an array of strings indicating the channels this provid
---
## Create a Notification Provider Module
## Create a Notification Module Provider
To create a notification provider module, refer to [this guide](/references/notification-provider-module).
To create a notification module provider, refer to [this guide](/references/notification-provider-module).