docs: improved plugin documentation (#1686)

* added plugin documentation

* replace incorrect plugin links

* small fixes
This commit is contained in:
Shahed Nasser
2022-06-17 14:13:05 +03:00
committed by GitHub
parent 8a4a7125b8
commit a4e0c074f0
13 changed files with 450 additions and 163 deletions
@@ -78,7 +78,7 @@ Additionally, if youre creating your Notification Provider as an external plu
:::info
You can learn more about plugins and how to create them in the [Plugins](../../../guides/plugins.md) documentation.
You can learn more about plugins and how to create them in the [Plugins](../plugins/overview.md) documentation.
:::
@@ -268,5 +268,5 @@ This request returns the same notification object as the List Notifications endp
- Check out the [list of events](../subscribers/events-list.md) you can listen to.
- Check out the [SendGrid](../../../add-plugins/sendgrid.mdx) plugin for easy integration of email notifications.
- Learn how to [create your own plugin](../../../guides/plugins.md).
- Learn how to [create your own plugin](../plugins/create.md).
- Learn more about [Subscribers](../subscribers/create-subscriber.md) and [Services](../services/create-service.md).
@@ -16,7 +16,7 @@ An example of a notification provider is SendGrid. When an order is placed, the
### How Notification Provider is Created
A Notification Provider is essentially a Medusa [Service](../services/create-service.md) with a unique identifier, and it extends the [`NotificationService`](../../../references/services/classes/NotificationService.md) provided by the `medusa-interfaces` package. It can be created as part of a [Plugin](../../../guides/plugins.md), or it can be created just as a Service file in your Medusa server.
A Notification Provider is essentially a Medusa [Service](../services/create-service.md) with a unique identifier, and it extends the [`NotificationService`](../../../references/services/classes/NotificationService.md) provided by the `medusa-interfaces` package. It can be created as part of a [Plugin](../plugins/overview.md), or it can be created just as a Service file in your Medusa server.
As a developer, you mainly work with the Notification Provider when integrating a third-party service that handles notifications in Medusa.