asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/architectural-modules/file/local/page.mdx
+3 -3
View File
@@ -1,12 +1,12 @@
import { Table } from "docs-ui"
export const metadata = {
title: `Local File Provider Module`,
title: `Local File Module Provider`,
}
# {metadata.title}
The Local File Provider Module stores files uploaded to your Medusa application in the `/uploads` directory.
The Local File Module Provider stores files uploaded to your Medusa application in the `/uploads` directory.
---
@@ -18,7 +18,7 @@ The Local File Module is installed by default in your application.
</Note>
To install the Local File Provider Module, run the following command in the directory of your Medusa application:
To install the Local File Module Provider, run the following command in the directory of your Medusa application:
```bash npm2yarn
npm install @medusajs/file-local-next
www/apps/resources/app/architectural-modules/file/page.mdx
+5 -5
View File
@@ -1,7 +1,7 @@
import { ChildDocs } from "docs-ui"
export const metadata = {
title: `File Provider Modules`,
title: `File Module Providers`,
}
# {metadata.title}
@@ -10,9 +10,9 @@ A File Module exposes the functionalities to upload assets, such as product imag
---
## What is a File Provider Module?
## What is a File Module Provider?
A file provider module implements the logic of handling uploads and downloads. The File Module must have one file provider module configured.
A file module provider implements the logic of handling uploads and downloads. The File Module must have one file module provider configured.
By default, Medusa uses the Local File Module. This module uploads files to the `uploads` directory of your Medusa application.
@@ -22,6 +22,6 @@ This is useful for development. However, for production, it’s highly recommend
---
## Create a File Provider Module
## Create a File Module Provider
To create a file provider module, refer to [this guide](/references/file-provider-module).
To create a file module provider, refer to [this guide](/references/file-provider-module).
www/apps/resources/app/architectural-modules/file/s3/page.mdx
+3 -3
View File
@@ -1,12 +1,12 @@
import { Table, Tabs, TabsList, TabsContent, TabsContentWrapper, TabsTrigger } from "docs-ui"
export const metadata = {
title: `S3 File Provider Module`,
title: `S3 File Module Provider`,
}
# {metadata.title}
The S3 File Provider Module integrates Amazon S3 and services following a compatible API (such as MinIO or DigitalOcean Spaces) to store files uploaded to your Medusa application.
The S3 File Module Provider integrates Amazon S3 and services following a compatible API (such as MinIO or DigitalOcean Spaces) to store files uploaded to your Medusa application.
---
@@ -70,7 +70,7 @@ The S3 File Provider Module integrates Amazon S3 and services following a compat
## Install the S3 File Module
To install the S3 File Provider Module, run the following command in the directory of your Medusa application:
To install the S3 File Module Provider, run the following command in the directory of your Medusa application:
```bash npm2yarn
npm install @medusajs/file-s3
www/apps/resources/app/architectural-modules/notification/local/page.mdx
+4 -4
View File
@@ -1,12 +1,12 @@
import { Table } from "docs-ui"
export const metadata = {
title: `Local Notification Provider Module`,
title: `Local Notification Module Provider`,
}
# {metadata.title}
The Local Notification Provider Module simulates sending a notification, but only logs the notification's details in the terminal. This is useful for development.
The Local Notification Module Provider simulates sending a notification, but only logs the notification's details in the terminal. This is useful for development.
---
@@ -14,11 +14,11 @@ The Local Notification Provider Module simulates sending a notification, but onl
<Note>
The Local Notification Provider Module is installed by default in your application.
The Local Notification Module Provider is installed by default in your application.
</Note>
To install the Local Notification Provider Module, run the following command in the directory of your Medusa application:
To install the Local Notification Module Provider, run the following command in the directory of your Medusa application:
```bash npm2yarn
npm install @medusajs/notification-local
www/apps/resources/app/architectural-modules/notification/page.mdx
+7 -7
View File
@@ -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).
www/apps/resources/app/architectural-modules/notification/send-notification/page.mdx
+2 -2
View File
@@ -15,7 +15,7 @@ In your resource, such as a subscriber, resolve the Notification Module's main s
export const highlights = [
["12", "notificationModuleService", "Resolve the Notification Module."],
["17", "create", "Create the notification to be sent."],
["19", '"email"', "Use the provider module defined for the `email` channel to send an email."],
["19", '"email"', "Use the module provider defined for the `email` channel to send an email."],
["20", '"product-created"', "The ID of the template defined in the third-party service, such as SendGrid."],
["21", "data", "The data to pass to the template defined in the third-party service."]
]
@@ -63,7 +63,7 @@ The `create` method accepts an object or an array of objects having the followin
{
name: "channel",
type: "`string`",
description: "The channel to send the notification through. For example, `email` or `sms`. The provider module defined for that channel will be used to send the notification.",
description: "The channel to send the notification through. For example, `email` or `sms`. The module provider defined for that channel will be used to send the notification.",
optional: false
},
{
www/apps/resources/app/architectural-modules/notification/sendgrid/page.mdx
+4 -4
View File
@@ -1,12 +1,12 @@
import { Table } from "docs-ui"
export const metadata = {
title: `SendGrid Notification Provider Module`,
title: `SendGrid Notification Module Provider`,
}
# {metadata.title}
The SendGrid Notification Provider Module integrates [SendGrid](https://sendgrid.com) to send emails to users and customers.
The SendGrid Notification Module Provider integrates [SendGrid](https://sendgrid.com) to send emails to users and customers.
---
@@ -20,7 +20,7 @@ The SendGrid Notification Provider Module integrates [SendGrid](https://sendgrid
</Note>
To install the SendGrid Notification Provider Module, run the following command in the directory of your Medusa application:
To install the SendGrid Notification Module Provider, run the following command in the directory of your Medusa application:
```bash npm2yarn
npm install @medusajs/notification-sendgrid
@@ -180,7 +180,7 @@ In this subscriber:
- Resolve the Notification Module's main service.
- Use the `create` method of the main service to create a notification to be sent to the specified email.
- By specifying the `email` channel, the SendGrid Notification Provider Module is used to send the notification.
- By specifying the `email` channel, the SendGrid Notification Module Provider is used to send the notification.
- The `template` property of the `create` method's parameter specifies the ID of the template defined in SendGrid.
- The `data` property allows you to pass data to the template in SendGrid.