docs: more updates after 2.7.0 update (#12156)

* docs: more updates after 2.7.0 update

* add versions

* small fix

* add plugin keywords

* change to text
This commit is contained in:
Shahed Nasser
2025-04-11 15:55:52 +03:00
committed by GitHub
parent 9d0b6a136f
commit f8023f419e
9 changed files with 15763 additions and 15495 deletions

View File

@@ -1,4 +1,4 @@
import { Prerequisites, CardList } from "docs-ui"
import { Prerequisites, CardList, Table } from "docs-ui"
export const metadata = {
title: `${pageNumber} Create a Plugin`,
@@ -65,18 +65,148 @@ For example:
### Package Keywords
In addition, make sure that the `keywords` field in `package.json` includes the keyword `medusa-plugin` and `medusa-v2`. This helps Medusa list community plugins on the Medusa website:
Medusa scrapes NPM for a list of plugins that integrate third-party services, to later showcase them on the Medusa website. If you want your plugin to appear in that listing, make sure to add the `medusa-v2` and `medusa-plugin-integration` keywords to the `keywords` field in `package.json`.
```json title="package.json"
{
"keywords": [
"medusa-plugin",
"medusa-plugin-integration",
"medusa-v2"
],
// ...
}
```
In addition, make sure to use one of the following keywords based on your integration type:
<Table>
<Table.Header>
<Table.Row>
<Table.HeaderCell>
Keyword
</Table.HeaderCell>
<Table.HeaderCell>
Description
</Table.HeaderCell>
<Table.HeaderCell>
Example
</Table.HeaderCell>
</Table.Row>
</Table.Header>
<Table.Body>
<Table.Row>
<Table.Cell>
`medusa-plugin-analytics`
</Table.Cell>
<Table.Cell>
Analytics service integration
</Table.Cell>
<Table.Cell>
Google Analytics
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`medusa-plugin-auth`
</Table.Cell>
<Table.Cell>
Authentication service integration
</Table.Cell>
<Table.Cell>
Auth0
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`medusa-plugin-cms`
</Table.Cell>
<Table.Cell>
CMS service integration
</Table.Cell>
<Table.Cell>
Contentful
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`medusa-plugin-notification`
</Table.Cell>
<Table.Cell>
Notification service integration
</Table.Cell>
<Table.Cell>
Twilio SMS
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`medusa-plugin-payment`
</Table.Cell>
<Table.Cell>
Payment service integration
</Table.Cell>
<Table.Cell>
PayPal
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`medusa-plugin-search`
</Table.Cell>
<Table.Cell>
Search service integration
</Table.Cell>
<Table.Cell>
MeiliSearch
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`medusa-plugin-shipping`
</Table.Cell>
<Table.Cell>
Shipping service integration
</Table.Cell>
<Table.Cell>
DHL
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`medusa-plugin-storage`
</Table.Cell>
<Table.Cell>
Storage or File service integration
</Table.Cell>
<Table.Cell>
Cloudinary
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`medusa-plugin-source`
</Table.Cell>
<Table.Cell>
Data migration integration
</Table.Cell>
<Table.Cell>
Shopify
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`medusa-plugin-other`
</Table.Cell>
<Table.Cell>
Other service integrations
</Table.Cell>
<Table.Cell>
Custom API Integration
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
### Package Dependencies
<Note>
@@ -459,6 +589,12 @@ To learn how to create module providers, refer to the following guides:
## 5. Publish Plugin to NPM
<Note title="Want your plugin to be listed in the Integrations page?">
Make sure to add the keywords mentioned in the [Package Keywords](#package-keywords) section in your plugin's `package.json` file.
</Note>
Medusa's CLI tool provides a command that bundles your plugin to be published to npm. Once you're ready to publish your plugin publicly, run the following command in your plugin project:
```bash

View File

@@ -103,7 +103,7 @@ export const generatedEditDates = {
"app/learn/fundamentals/data-models/check-constraints/page.mdx": "2024-12-06T14:34:50.384Z",
"app/learn/fundamentals/module-links/link/page.mdx": "2025-04-07T08:03:14.513Z",
"app/learn/fundamentals/workflows/store-executions/page.mdx": "2025-02-11T15:56:03.835Z",
"app/learn/fundamentals/plugins/create/page.mdx": "2025-04-07T14:50:53.866Z",
"app/learn/fundamentals/plugins/create/page.mdx": "2025-04-11T10:39:31.589Z",
"app/learn/fundamentals/plugins/page.mdx": "2025-01-22T10:14:10.433Z",
"app/learn/customization/reuse-customizations/page.mdx": "2025-01-22T10:01:57.665Z",
"app/learn/update/page.mdx": "2025-01-27T08:45:19.030Z",

File diff suppressed because it is too large Load Diff

View File

@@ -43,6 +43,40 @@ import { Table } from "docs-ui"
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`location.list.side.before`
</Table.Cell>
<Table.Cell>
Added at the top of the second column in the locations list page. This injection zone is available since [Medusa v2.7.0](https://github.com/medusajs/medusa/releases/tag/v2.7.0).
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>
`location.list.side.after`
</Table.Cell>
<Table.Cell>
Added at the bottom of the second column in the locations list page. This injection zone is available since [Medusa v2.7.0](https://github.com/medusajs/medusa/releases/tag/v2.7.0).
</Table.Cell>
<Table.Cell>
\-
</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>

View File

@@ -5,7 +5,7 @@ import CustomerEvents from "../commerce-modules/customer/events/_content.mdx"
import FulfillmentEvents from "../commerce-modules/fulfillment/events/_content.mdx"
import InviteEvents from "../commerce-modules/user/events/_content/invite.mdx"
import OrderEvents from "../commerce-modules/order/events/_content.mdx"
import PaymentEvents from "../commerce-modules/payment/events/page.mdx"
import PaymentEvents from "../commerce-modules/payment/events/_content.mdx"
import ProductEvents from "../commerce-modules/product/events/_content/product.mdx"
import ProductCategoryEvents from "../commerce-modules/product/events/_content/product-category.mdx"
import ProductCollectionEvents from "../commerce-modules/product/events/_content/product-collection.mdx"

View File

@@ -1087,6 +1087,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Implement Loyalty Points",
"path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/loyalty-points",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -2404,6 +2412,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "/commerce-modules/customer/extend",
"title": "Extend Module",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Loyalty Points",
"path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/loyalty-points",
"children": []
}
]
},
@@ -5953,6 +5969,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"title": "Implement Quote Management",
"path": "https://docs.medusajs.com/resources/examples/guides/quote-management",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Loyalty Points",
"path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/loyalty-points",
"children": []
}
]
},
@@ -12759,6 +12783,14 @@ const generatedgeneratedCommerceModulesSidebarSidebar = {
"path": "/commerce-modules/promotion/extend",
"title": "Extend Module",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Loyalty Points",
"path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/loyalty-points",
"children": []
}
]
},

View File

@@ -170,6 +170,45 @@ To edit the customer's metadata:
---
## Manage Customer's Addresses
You can view and manage a customer's address from the "Addresses" section on the customer's details page. This is useful when you need to make changes to the customer's shipping or billing address in an order.
<Note>
The Address section and management features are only available after This injection zone is available since [Medusa v2.7.0](https://github.com/medusajs/medusa/releases/tag/v2.7.0).
</Note>
### Add Customer Address
To add an address to a customer:
1. Go to the customer's details page.
2. Click on the "Add" button at the top right of the "Addresses" section.
3. In the form that opens, enter the address details including name, address line, apartment, postal code, city, country, state, company, and phone number.
4. Once you're done, click the Save button.
![Add address form](https://res.cloudinary.com/dza7lstvk/image/upload/v1744363680/User%20Guide/Screenshot_2025-04-11_at_12.27.45_PM_h0fkqm.png)
### Delete Customer Address
<Note type="warning">
Deleting an address is irreversible.
</Note>
To delete a customer address:
1. Go to the customer's details page.
2. Find the address in the "Addresses" section.
3. Click on the <InlineIcon Icon={EllipsisHorizontal} alt="three dots" /> icon at the right of the address.
4. Choose Delete from the dropdown.
5. In the pop-up, enter the address name and click the "Delete" button.
---
## Delete a Customer
<Note type="warning">

View File

@@ -10,13 +10,13 @@ export const metadata = {
Medusa Admin comes with multi-language support. Multi-language support is only for the Medusa Admin interface, not for the content, such as product description.
This document covers the complete list of available languages, both official and by the community. To learn how to change the language, refer to [this documentation](../../settings/profile/page.mdx).
This document covers the complete list of available languages, both official and by the community.
<Note>
## How to Change the Language
Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!docs!/learn/resources/contribution-guidelines/admin-translations).
To learn how to change the language, refer to the [Manage Profile](../../settings/profile/page.mdx) guide.
</Note>
---
## Official Languages
@@ -30,22 +30,32 @@ Languages listed in this section are contributed by the Medusa community. So, th
</Note>
- Español
- Ελληνικά
- Čeština
- Deutsch
- Español
- Français
- Italiano
- 日本語
- Lietuviškai
- Polski
- Português (Brasil)
- Türkçe
- ไทย
- Українська
- Română
- Tiếng Việt
- Türkçe
- Ελληνικά
- Български
- Македонски
- Монгол
- العربية
- 简体中文
- فارسی
- Čeština
- Русский
- Українська
- العربية
- فارسی
- ไทย
- 한국어
- 日本語
- 简体中文
<Note>
Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!docs!/learn/resources/contribution-guidelines/admin-translations).
</Note>

View File

@@ -1,5 +1,5 @@
export const generatedEditDates = {
"app/tips/languages/page.mdx": "2025-03-06T08:49:32.514Z",
"app/tips/languages/page.mdx": "2025-04-11T09:14:21.012Z",
"app/tips/bulk-editor/page.mdx": "2025-04-07T13:20:09.040Z",
"app/tips/lists/page.mdx": "2025-02-14T14:16:04.867Z",
"app/settings/sales-channels/page.mdx": "2025-02-19T17:33:55.584Z",
@@ -29,7 +29,7 @@ export const generatedEditDates = {
"app/customers/page.mdx": "2025-02-18T15:38:17.543Z",
"app/orders/edit/page.mdx": "2025-02-17T15:15:53.489Z",
"app/products/collections/page.mdx": "2025-02-18T14:00:51.469Z",
"app/customers/manage/page.mdx": "2025-02-19T10:20:05.606Z",
"app/customers/manage/page.mdx": "2025-04-11T09:30:20.738Z",
"app/discounts/create/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/payments/page.mdx": "2025-02-17T15:10:24.250Z",
"app/discounts/page.mdx": "2024-05-03T17:36:38+03:00",