docs: add notes + missing links for user guide (#11621)

* docs: add notes + missing links for user guide

* fix build errors

* fixes
This commit is contained in:
Shahed Nasser
2025-02-26 15:28:18 +02:00
committed by GitHub
parent 322d108c03
commit 95eef899f7
76 changed files with 736 additions and 794 deletions
@@ -8,6 +8,12 @@ export const metadata = {
In this section of the documentation, you will find resources to learn more about the Payment Module and how to use it in your application.
<Note title="Looking for no-code docs?">
Refer to the [Medusa Admin User Guide](!user-guide!/orders/payments) to learn how to manage order payments using the dashboard.
</Note>
Medusa has payment related features available out-of-the-box through the Payment Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Payment Module.
<Note>
@@ -8,6 +8,12 @@ export const metadata = {
In this document, youll learn what a payment module provider is.
<Note title="Looking for no-code docs?">
Refer to this [Medusa Admin User Guide](!user-guide!/settings/regions) to learn how to manage the payment providers available in a region using the dashboard.
</Note>
## What's a Payment Module Provider?
A payment module provider registers a payment provider that handles payment processing in the Medusa application. It integrates third-party payment providers, such as Stripe.
@@ -12,6 +12,12 @@ export const metadata = {
In this document, youll learn about the Stripe Module Provider and how to configure it in the Payment Module.
<Note title="Looking for no-code docs?">
Your technical team must install the Stripe Module Provider in your Medusa application first. Then, refer to [this user guide](!user-guide!/settings/regions#edit-region-details) to learn how to enable the Stripe payment provider in a region using the Medusa Admin dashboard.
</Note>
## Register the Stripe Module Provider
<Prerequisites items={[
@@ -192,6 +198,14 @@ STRIPE_API_KEY=<YOUR_STRIPE_API_KEY>
---
## Enable Stripe Providers in a Region
Before customers can use Stripe to complete their purchases, you must enable the Stripe payment provider(s) in the region where you want to offer this payment method.
Refer to the [user guide](!user-guide!/settings/regions#edit-region-details) to learn how to edit a region and enable the Stripe payment provider.
---
## Setup Stripe Webhooks
For production applications, you must set up webhooks in Stripe that inform Medusa of changes and updates to payments. Refer to [Stripe's documentation](https://docs.stripe.com/webhooks#add-a-webhook-endpoint) on how to setup webhooks.