Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: revise integrations page #10518

Merged
merged 1 commit into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 62 additions & 20 deletions www/apps/resources/app/integrations/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,66 +6,108 @@ export const metadata = {

# {metadata.title}

Find in this document Medusa's modules that integrate third-party services and systems.
You can integrate any third-party service to Medusa, including storage services, notification systems, Content-Management Systems (CMS), etc… By integrating third-party services, you build flows and synchronize data around these integrations, making Medusa not only your commerce application, but a middleware layer between your data sources and operations.

## File
Medusa provides integrations out-of-the-box that are listed here, but you can also create your own integrations, such as integrating ERP systems, as explained in [this guide](!docs!/learn/customization/integrate-systems).

## Auth

Learn how to create a file provider in [this guide](/references/file-provider-module).
An Auth Module Provider authenticates users with their account on a third-party service.

<CardList
items={[
{
href: "/architectural-modules/file/s3",
title: "AWS S3 (and Compatible APIs)"
}
href: "/commerce-modules/auth/auth-providers/google",
title: "Google",
},
{
href: "/commerce-modules/auth/auth-providers/github",
title: "GitHub",
},
]}
className="mb-1"
/>

Learn how to create a custom third-party authentication provider in [this guide](/references/auth/provider).

---

## Notification
## CMS

Learn how to create a notification provider in [this guide](/references/notification-provider-module).
Integrate third-party CMS to utilize rich content-related features.

<CardList
items={[
{
href: "/architectural-modules/notification/sendgrid",
title: "SendGrid"
}
href: "/integrations/guides/sanity",
title: "Sanity",
badge: {
variant: "blue",
children: "Guide"
}
},
]}
className="mb-1"
/>

---

## Payment
## File

Learn how to create a payment provider in [this guide](/references/payment/provider).
A File Module Provider uploads and manages assets, such as product images, on a third-party service.

<CardList
items={[
{
href: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe"
href: "/architectural-modules/file/s3",
title: "AWS S3 (and Compatible APIs)"
}
]}
className="mb-1"
/>

Learn how to create a custom third-party file or storage provider in [this guide](/references/file-provider-module).

---

## Guides
## Notification

The following guides are step-by-step guides on how to integrate Medusa to third-party systems.
A Notification Module Provider sends messages to users and customers in your Medusa application using a third-party service.

<CardList
items={[
{
href: "/integrations/guides/sanity",
title: "Sanity"
href: "/architectural-modules/notification/sendgrid",
title: "SendGrid"
},
{
href: "/integrations/guides/resend",
title: "Resend"
title: "Resend",
badge: {
variant: "blue",
children: "Guide"
}
}
]}
className="mb-1"
/>

Learn how to create a notification provider in [this guide](/references/notification-provider-module).

---

## Payment

A Payment Module Provider processes payments made in your Medusa store using a third-party service.

<CardList
items={[
{
href: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe"
}
]}
className="mb-1"
/>

Learn how to create a payment provider in [this guide](/references/payment/provider).
2 changes: 1 addition & 1 deletion www/apps/resources/generated/edit-dates.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ export const generatedEditDates = {
"app/deployment/medusa-application/railway/page.mdx": "2024-11-11T11:50:10.517Z",
"app/deployment/storefront/vercel/page.mdx": "2024-07-26T07:21:31+00:00",
"app/deployment/page.mdx": "2024-11-25T14:31:45.277Z",
"app/integrations/page.mdx": "2024-11-19T10:09:54.075Z",
"app/integrations/page.mdx": "2024-12-10T08:20:41.203Z",
"app/medusa-cli/page.mdx": "2024-08-28T11:25:32.382Z",
"app/medusa-container-resources/page.mdx": "2024-12-09T16:18:38.852Z",
"app/medusa-workflows-reference/page.mdx": "2024-12-09T16:22:32.129Z",
Expand Down
48 changes: 36 additions & 12 deletions www/apps/resources/generated/sidebar.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -7987,14 +7987,22 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "File",
"title": "Auth",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/file/s3",
"title": "AWS",
"path": "/commerce-modules/auth/auth-providers/google",
"title": "Google",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/auth/auth-providers/github",
"title": "GitHub",
"children": []
}
]
Expand All @@ -8003,14 +8011,14 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Notification",
"title": "CMS",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/notification/sendgrid",
"title": "SendGrid",
"path": "/integrations/guides/sanity",
"title": "Sanity",
"children": []
}
]
Expand All @@ -8019,14 +8027,14 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Payment",
"title": "File",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/payment/payment-provider/stripe",
"title": "Stripe",
"path": "/architectural-modules/file/s3",
"title": "AWS",
"children": []
}
]
Expand All @@ -8035,14 +8043,14 @@ export const generatedSidebar = [
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Guides",
"title": "Notification",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/integrations/guides/sanity",
"title": "Sanity",
"path": "/architectural-modules/notification/sendgrid",
"title": "SendGrid",
"children": []
},
{
Expand All @@ -8054,6 +8062,22 @@ export const generatedSidebar = [
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "category",
"title": "Payment",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/commerce-modules/payment/payment-provider/stripe",
"title": "Stripe",
"children": []
}
]
}
]
},
Expand Down
40 changes: 28 additions & 12 deletions www/apps/resources/sidebar.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -1746,45 +1746,50 @@ export const sidebar = sidebarAttachHrefCommonOptions([
children: [
{
type: "category",
title: "File",
title: "Auth",
children: [
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS",
path: "/commerce-modules/auth/auth-providers/google",
title: "Google",
},
{
type: "link",
path: "/commerce-modules/auth/auth-providers/github",
title: "GitHub",
},
],
},
{
type: "category",
title: "Notification",
title: "CMS",
children: [
{
type: "link",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
path: "/integrations/guides/sanity",
title: "Sanity",
},
],
},
{
type: "category",
title: "Payment",
title: "File",
children: [
{
type: "link",
path: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe",
path: "/architectural-modules/file/s3",
title: "AWS",
},
],
},
{
type: "category",
title: "Guides",
title: "Notification",
children: [
{
type: "link",
path: "/integrations/guides/sanity",
title: "Sanity",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
},
{
type: "link",
Expand All @@ -1793,6 +1798,17 @@ export const sidebar = sidebarAttachHrefCommonOptions([
},
],
},
{
type: "category",
title: "Payment",
children: [
{
type: "link",
path: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe",
},
],
},
],
},
{
Expand Down
Loading