asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

514
www/apps/docs/content/plugins/cms/contentful.md → www/apps/docs/content/plugins/cms/contentful.mdx
View File

@@ -95,69 +95,59 @@ const plugins = [
The rest of this section includes the field names you can customize using this option for each content model type.
<details>
<summary>
product
</summary>
<Details>
<Summary>product</Summary>
- `title`
- `subtitle`
- `description`
- `variants`
- `options`
- `medusaId`
- `type`
- `collection`
- `tags`
- `handle`
- `title`
- `subtitle`
- `description`
- `variants`
- `options`
- `medusaId`
- `type`
- `collection`
- `tags`
- `handle`
</details>
</Details>
<details>
<summary>
variant
</summary>
<Details>
<Summary>variant</Summary>
- `title`
- `sku`
- `prices`
- `options`
- `medusaId`
- `title`
- `sku`
- `prices`
- `options`
- `medusaId`
</details>
</Details>
<details>
<summary>
region
</summary>
<Details>
<Summary>region</Summary>
- `name`
- `countries`
- `paymentProviders`
- `fulfillmentProviders`
- `medusaId`
- `name`
- `countries`
- `paymentProviders`
- `fulfillmentProviders`
- `medusaId`
</details>
</Details>
<details>
<summary>
collection
</summary>
<Details>
<Summary>collection</Summary>
- `title`
- `medusaId`
- `title`
- `medusaId`
</details>
</Details>
<details>
<summary>
type
</summary>
<Details>
<Summary>type</Summary>
- `name`
- `medusaId`
- `name`
- `medusaId`
</details>
</Details>
### Migrate Content Models
@@ -173,252 +163,244 @@ Before creating the migration scripts, run the following command in the root of
npm install --save-dev contentful-migration
```
<details>
<summary>
product Content Model
</summary>
<Details>
<Summary>product Content Model</Summary>
Create the file `src/loaders/contentful-migrations/product.ts` with the following content:
Create the file `src/loaders/contentful-migrations/product.ts` with the following content:
```ts title=src/loaders/contentful-migrations/product.ts
import Migration, {
MigrationContext,
} from "contentful-migration"
```ts title=src/loaders/contentful-migrations/product.ts
import Migration, {
MigrationContext,
} from "contentful-migration"
export function productMigration(
migration: Migration,
context?: MigrationContext
) {
const product = migration
.createContentType("product")
.name("Product")
.displayField("title")
export function productMigration(
migration: Migration,
context?: MigrationContext
) {
const product = migration
.createContentType("product")
.name("Product")
.displayField("title")
product
.createField("title")
.name("Title")
.type("Symbol")
.required(true)
product
.createField("subtitle")
.name("Subtitle")
.type("Symbol")
product
.createField("handle")
.name("Handle")
.type("Symbol")
product
.createField("thumbnail")
.name("Thumbnail")
.type("Link")
.linkType("Asset")
product
.createField("description")
.name("Description")
.type("Text")
product
.createField("options")
.name("Options")
.type("Object")
product
.createField("tags")
.name("Tags")
.type("Object")
product
.createField("collection")
.name("Collection")
.type("Symbol")
product
.createField("type")
.name("Type")
.type("Symbol")
product
.createField("variants")
.name("Variants")
.type("Array")
.items({
type: "Link",
linkType: "Entry",
validations: [
{
linkContentType: ["productVariant"],
},
],
})
product
.createField("medusaId")
.name("Medusa ID")
.type("Symbol")
}
```
</details>
<details>
<summary>
productVariant Content Model
</summary>
Create the file `src/loaders/contentful-migrations/product-variant.ts` with the following content:
```ts title=src/loaders/contentful-migrations/product-variant.ts
import Migration, {
MigrationContext,
} from "contentful-migration"
export function productVariantMigration(
migration: Migration,
context?: MigrationContext
) {
const productVariant = migration
.createContentType("productVariant")
.name("Product Variant")
.displayField("title")
productVariant
.createField("title")
.name("Title")
.type("Symbol")
.required(true)
productVariant
.createField("sku")
.name("SKU")
.type("Symbol")
productVariant
.createField("options")
.name("Options")
.type("Object")
productVariant
.createField("prices")
.name("Prices")
.type("Object")
productVariant
.createField("medusaId")
.name("Medusa ID")
.type("Symbol")
}
```
</details>
<details>
<summary>
collection Content Model
</summary>
Create the file `src/loaders/contentful-migrations/product-collection.ts` with the following content:
```ts title=src/loaders/contentful-migrations/product-collection.ts
import Migration, {
MigrationContext,
} from "contentful-migration"
export function productCollectionMigration(
migration: Migration,
context?: MigrationContext
) {
const collection = migration
.createContentType("collection")
.name("Product Collection")
.displayField("title")
collection
product
.createField("title")
.name("Title")
.type("Symbol")
.required(true)
collection
product
.createField("subtitle")
.name("Subtitle")
.type("Symbol")
product
.createField("handle")
.name("Handle")
.type("Symbol")
product
.createField("thumbnail")
.name("Thumbnail")
.type("Link")
.linkType("Asset")
product
.createField("description")
.name("Description")
.type("Text")
product
.createField("options")
.name("Options")
.type("Object")
product
.createField("tags")
.name("Tags")
.type("Object")
product
.createField("collection")
.name("Collection")
.type("Symbol")
product
.createField("type")
.name("Type")
.type("Symbol")
product
.createField("variants")
.name("Variants")
.type("Array")
.items({
type: "Link",
linkType: "Entry",
validations: [
{
linkContentType: ["productVariant"],
},
],
})
product
.createField("medusaId")
.name("Medusa ID")
.type("Symbol")
}
```
</details>
}
```
<details>
<summary>
productType Content Model
</summary>
</Details>
Create the file `src/loaders/contentful-migrations/product-type.ts` with the following content:
<Details>
<Summary>productVariant Content Model</Summary>
```ts title=src/loaders/contentful-migrations/product-type.ts
import Migration, {
MigrationContext,
} from "contentful-migration"
Create the file `src/loaders/contentful-migrations/product-variant.ts` with the following content:
export function productTypeMigration(
migration: Migration,
context?: MigrationContext
) {
const collection = migration
.createContentType("productType")
.name("Product Type")
.displayField("title")
```ts title=src/loaders/contentful-migrations/product-variant.ts
import Migration, {
MigrationContext,
} from "contentful-migration"
collection
export function productVariantMigration(
migration: Migration,
context?: MigrationContext
) {
const productVariant = migration
.createContentType("productVariant")
.name("Product Variant")
.displayField("title")
productVariant
.createField("title")
.name("Title")
.type("Symbol")
.required(true)
collection
productVariant
.createField("sku")
.name("SKU")
.type("Symbol")
productVariant
.createField("options")
.name("Options")
.type("Object")
productVariant
.createField("prices")
.name("Prices")
.type("Object")
productVariant
.createField("medusaId")
.name("Medusa ID")
.type("Symbol")
}
```
</details>
}
```
</Details>
<Details>
<Summary>collection Content Model</Summary>
Create the file `src/loaders/contentful-migrations/product-collection.ts` with the following content:
```ts title=src/loaders/contentful-migrations/product-collection.ts
import Migration, {
MigrationContext,
} from "contentful-migration"
export function productCollectionMigration(
migration: Migration,
context?: MigrationContext
) {
const collection = migration
.createContentType("collection")
.name("Product Collection")
.displayField("title")
collection
.createField("title")
.name("Title")
.type("Symbol")
.required(true)
collection
.createField("medusaId")
.name("Medusa ID")
.type("Symbol")
}
```
</Details>
<Details>
<Summary>productType Content Model</Summary>
Create the file `src/loaders/contentful-migrations/product-type.ts` with the following content:
```ts title=src/loaders/contentful-migrations/product-type.ts
import Migration, {
MigrationContext,
} from "contentful-migration"
export function productTypeMigration(
migration: Migration,
context?: MigrationContext
) {
const collection = migration
.createContentType("productType")
.name("Product Type")
.displayField("title")
collection
.createField("title")
.name("Title")
.type("Symbol")
.required(true)
collection
.createField("medusaId")
.name("Medusa ID")
.type("Symbol")
}
```
</Details>
<details>
<summary>
region Content Model
</summary>
<Details>
<Summary>region Content Model</Summary>
Create the file `src/loaders/contentful-migrations/region.ts` with the following content:
Create the file `src/loaders/contentful-migrations/region.ts` with the following content:
```ts title=src/loaders/contentful-migrations/region.ts
import Migration, {
MigrationContext,
} from "contentful-migration"
```ts title=src/loaders/contentful-migrations/region.ts
import Migration, {
MigrationContext,
} from "contentful-migration"
export function regionMigration(
migration: Migration,
context?: MigrationContext
) {
const region = migration
.createContentType("region")
.name("Region")
.displayField("name")
export function regionMigration(
migration: Migration,
context?: MigrationContext
) {
const region = migration
.createContentType("region")
.name("Region")
.displayField("name")
region
.createField("name")
.name("Name")
.type("Symbol")
.required(true)
region
.createField("countries")
.name("Options")
.type("Object")
region
.createField("paymentProviders")
.name("Payment Providers")
.type("Object")
region
.createField("fulfillmentProviders")
.name("Fulfillment Providers")
.type("Object")
region
.createField("currencyCode")
.name("Currency Code")
.type("Symbol")
region
.createField("medusaId")
.name("Medusa ID")
.type("Symbol")
}
```
region
.createField("name")
.name("Name")
.type("Symbol")
.required(true)
region
.createField("countries")
.name("Options")
.type("Object")
region
.createField("paymentProviders")
.name("Payment Providers")
.type("Object")
region
.createField("fulfillmentProviders")
.name("Fulfillment Providers")
.type("Object")
region
.createField("currencyCode")
.name("Currency Code")
.type("Symbol")
region
.createField("medusaId")
.name("Medusa ID")
.type("Symbol")
}
```
</details>
</Details>
Finally, create a [loader](../../development/loaders/overview.mdx) at `src/loaders/index.ts` with the following content:

98
www/apps/docs/content/plugins/notifications/sendgrid.mdx
View File

@@ -71,7 +71,7 @@ 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.
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.
:::note
@@ -85,9 +85,9 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when they place a new order.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
"beforeInsert": [Function],
@@ -304,7 +304,8 @@ You don’t have to create a template for every type in the reference. You can s
"updated_at": Any<Date>,
}
```
</details>
</Details>
### Order Canceled
@@ -312,8 +313,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to a customer when their order is canceled.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -535,7 +536,8 @@ You don’t have to create a template for every type in the reference. You can s
"updated_at": Any<Date>,
}
```
</details>
</Details>
### Order Shipment Created
@@ -543,8 +545,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a shipment of their order has been created.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -817,7 +819,8 @@ You don’t have to create a template for every type in the reference. You can s
"tracking_number": "",
}
```
</details>
</Details>
### Order Return Requested
@@ -825,8 +828,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a return request is made for an order.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -1259,7 +1262,8 @@ You don’t have to create a template for every type in the reference. You can s
"subtotal": "12.00 USD",
}
```
</details>
</Details>
### Order Items Returned
@@ -1267,8 +1271,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when an order’s items have been returned.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -1701,7 +1705,8 @@ You don’t have to create a template for every type in the reference. You can s
"subtotal": "12.00 USD",
}
```
</details>
</Details>
### Claim Shipment Created
@@ -1709,8 +1714,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a Claim shipment has been created.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -1998,7 +2003,8 @@ You don’t have to create a template for every type in the reference. You can s
"tracking_number": "",
}
```
</details>
</Details>
### Swap Created
@@ -2006,8 +2012,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a swap for an order has been created.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -2507,7 +2513,8 @@ You don’t have to create a template for every type in the reference. You can s
"additional_total": "11.25 USD"
}
```
</details>
</Details>
### Swap Shipment Created
@@ -2515,8 +2522,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a shipment of a swap of an order has been created.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
Object {
@@ -3087,7 +3094,8 @@ You don’t have to create a template for every type in the reference. You can s
"tracking_number": "",
}
```
</details>
</Details>
### Swap Received
@@ -3095,8 +3103,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when a swap of an order has been received.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
{
@@ -3597,7 +3605,8 @@ You don’t have to create a template for every type in the reference. You can s
"additional_total": "11.25 USD"
}
```
</details>
</Details>
### Gift Card Created
@@ -3605,8 +3614,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be to the customer sent when a gift card in their order has been created.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
Object {
@@ -3765,7 +3774,8 @@ You don’t have to create a template for every type in the reference. You can s
"display_value": 4
}
```
</details>
</Details>
### Customer Password Reset
@@ -3773,8 +3783,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the customer when they request a password reset.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
Object {
@@ -3785,7 +3795,8 @@ You don’t have to create a template for every type in the reference. You can s
"token": Any<String>,
}
```
</details>
</Details>
### User Password Reset
@@ -3793,8 +3804,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to the admin user when they request a password reset.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
Object {
@@ -3802,7 +3813,8 @@ You don’t have to create a template for every type in the reference. You can s
"token": Any<String>,
}
```
</details>
</Details>
### Restock Notification
@@ -3810,8 +3822,8 @@ You don’t have to create a template for every type in the reference. You can s
**Description:** Template to be sent to admin users when a product has hit the restock quantity threshold.
<details>
<summary>Example Data</summary>
<Details>
<Summary>Example Data</Summary>
```json noReport
Object {
@@ -3899,7 +3911,8 @@ You don’t have to create a template for every type in the reference. You can s
]
}
```
</details>
</Details>
---
@@ -4004,8 +4017,7 @@ export const POST = async (
to: "customer@mail.com",
dynamic_template_data: { dynamic: "data" },
}
sendgridService.sendEmail(sendOptions)
sendgridService.sendEmail(sendOptions)
}
```