docs: added dividers + see also section (#2899)

This commit is contained in:
Shahed Nasser
2022-12-26 15:52:08 +02:00
committed by GitHub
parent b0e5769e27
commit b0ebfd6bcf
100 changed files with 1047 additions and 291 deletions
+15 -3
View File
@@ -20,12 +20,16 @@ By integrating SendGrid with Medusa, youll be sending email notifications to
4. User-related events including reset passwords.
5. Restock Notifications for when product stocks are low.
---
## Prerequisites
Before going further with this guide make sure you have a Medusa server set up. You can follow the [Quickstart guide](../quickstart/quick-start.mdx).
You also must have [Redis configured on your Medusa server](/tutorial/set-up-your-development-environment#redis). Sending emails is done through Subscribers, which uses Redis as the event queue. If you dont set up Redis, the plugin will not send emails.
---
## Create a SendGrid Account
If you dont have a SendGrid account, make sure to [create one](https://signup.sendgrid.com) first. You also need to set up a [single sender](https://docs.sendgrid.com/ui/sending-email/sender-verification) first in SendGrid before you can start sending emails.
@@ -60,6 +64,8 @@ Medusa supports localization so you can also create multiple templates for multi
:::
---
## Template Reference
This section covers the template types supported by the plugin and what variables you can expect in your dynamic template. You can use the variables to add details like order total or customer name.
@@ -3891,6 +3897,8 @@ You dont have to create a template for every type in the reference. You can s
```
</details>
---
## Install the SendGrid Plugin
In the directory of your Medusa server run the following command to install the SendGrid plugin:
@@ -3941,6 +3949,8 @@ The `api_key` and `from` options are required. Then, use the key of each templat
You can also optionally pass the option `localization` if you want to support different languages. `localization` accepts an object that has the country and language codes as keys. The value for each code should be an object of template keys and their IDs as values. Make sure to include the localized template IDs in `.env` as well.
---
## Test it Out
Run your server now:
@@ -3961,7 +3971,9 @@ You can also track analytics related to emails sent from the SendGrid dashboard.
![SendGrid Analytics](https://res.cloudinary.com/dza7lstvk/image/upload/v1668000788/Medusa%20Docs/SendGrid/X01LigH_mxmtbn.png)
## Whats Next
---
- Learn more about how [Notifications work in Medusa](../advanced/backend/notification/overview.md).
- Install the [Medusa admin](https://github.com/medusajs/admin#-setting-up-admin) for functionalities like Gift Cards creation, swaps, claims, order return requests, and more.
## See Also
- [Notifications Overview](../advanced/backend/notification/overview.md)
- Install the [Medusa admin](../admin/quickstart.mdx) for functionalities like Gift Cards creation, swaps, claims, order return requests, and more.