docs: added how-to guides for architectural modules (#11883)

* added initial how-tos

* finished changes

* generated sidebars
This commit is contained in:
Shahed Nasser
2025-03-18 09:49:19 +02:00
committed by GitHub
parent 0099c1e2e9
commit cb68a9e67b
37 changed files with 5265 additions and 68 deletions
+9 -1
View File
@@ -6049,5 +6049,13 @@ export const generatedEditDates = {
"app/architectural-modules/locking/redis/page.mdx": "2025-03-12T10:07:43.867Z",
"references/locking/interfaces/locking.ILockingModule/page.mdx": "2025-03-12T12:28:30.425Z",
"references/locking/interfaces/locking.ILockingProvider/page.mdx": "2025-03-12T12:28:30.422Z",
"references/modules/locking/page.mdx": "2025-03-12T12:28:30.419Z"
"references/modules/locking/page.mdx": "2025-03-12T12:28:30.419Z",
"references/cache/interfaces/cache.ICacheService/page.mdx": "2025-03-17T15:24:02.574Z",
"references/event/interfaces/event.IEventBusModuleService/page.mdx": "2025-03-17T15:24:03.025Z",
"references/file_service/interfaces/file_service.IFileModuleService/page.mdx": "2025-03-17T15:24:03.031Z",
"references/modules/cache/page.mdx": "2025-03-17T15:24:02.572Z",
"references/modules/event/page.mdx": "2025-03-17T15:24:03.021Z",
"references/modules/file_service/page.mdx": "2025-03-17T15:24:03.025Z",
"references/modules/notification_service/page.mdx": "2025-03-17T15:24:05.164Z",
"references/notification_service/interfaces/notification_service.INotificationModuleService/page.mdx": "2025-03-17T15:24:05.173Z"
}
@@ -123,6 +123,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/architectural-modules/page.mdx",
"pathname": "/architectural-modules"
},
{
"filePath": "/www/apps/resources/app/architectural-modules/workflow-engine/how-to-use/page.mdx",
"pathname": "/architectural-modules/workflow-engine/how-to-use"
},
{
"filePath": "/www/apps/resources/app/architectural-modules/workflow-engine/in-memory/page.mdx",
"pathname": "/architectural-modules/workflow-engine/in-memory"
@@ -1691,6 +1695,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx",
"pathname": "/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider"
},
{
"filePath": "/www/apps/resources/references/cache/interfaces/cache.ICacheService/page.mdx",
"pathname": "/references/cache/interfaces/cache.ICacheService"
},
{
"filePath": "/www/apps/resources/references/cart/IBigNumber/methods/cart.IBigNumber.toJSON/page.mdx",
"pathname": "/references/cart/IBigNumber/methods/cart.IBigNumber.toJSON"
@@ -9571,10 +9579,18 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/dml/properties_base/classes/dml.properties_base.BaseProperty/page.mdx",
"pathname": "/references/dml/properties_base/classes/dml.properties_base.BaseProperty"
},
{
"filePath": "/www/apps/resources/references/event/interfaces/event.IEventBusModuleService/page.mdx",
"pathname": "/references/event/interfaces/event.IEventBusModuleService"
},
{
"filePath": "/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx",
"pathname": "/references/file/classes/file.AbstractFileProviderService"
},
{
"filePath": "/www/apps/resources/references/file_service/interfaces/file_service.IFileModuleService/page.mdx",
"pathname": "/references/file_service/interfaces/file_service.IFileModuleService"
},
{
"filePath": "/www/apps/resources/references/fulfillment/IBigNumber/methods/fulfillment.IBigNumber.toJSON/page.mdx",
"pathname": "/references/fulfillment/IBigNumber/methods/fulfillment.IBigNumber.toJSON"
@@ -12967,6 +12983,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/modules/auth_provider/page.mdx",
"pathname": "/references/modules/auth_provider"
},
{
"filePath": "/www/apps/resources/references/modules/cache/page.mdx",
"pathname": "/references/modules/cache"
},
{
"filePath": "/www/apps/resources/references/modules/cart/page.mdx",
"pathname": "/references/modules/cart"
@@ -12999,10 +13019,18 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/modules/dml/page.mdx",
"pathname": "/references/modules/dml"
},
{
"filePath": "/www/apps/resources/references/modules/event/page.mdx",
"pathname": "/references/modules/event"
},
{
"filePath": "/www/apps/resources/references/modules/file/page.mdx",
"pathname": "/references/modules/file"
},
{
"filePath": "/www/apps/resources/references/modules/file_service/page.mdx",
"pathname": "/references/modules/file_service"
},
{
"filePath": "/www/apps/resources/references/modules/fulfillment/page.mdx",
"pathname": "/references/modules/fulfillment"
@@ -13051,6 +13079,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/modules/notification/page.mdx",
"pathname": "/references/modules/notification"
},
{
"filePath": "/www/apps/resources/references/modules/notification_service/page.mdx",
"pathname": "/references/modules/notification_service"
},
{
"filePath": "/www/apps/resources/references/modules/order/page.mdx",
"pathname": "/references/modules/order"
@@ -13239,6 +13271,10 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx",
"pathname": "/references/notification/classes/notification.AbstractNotificationProviderService"
},
{
"filePath": "/www/apps/resources/references/notification_service/interfaces/notification_service.INotificationModuleService/page.mdx",
"pathname": "/references/notification_service/interfaces/notification_service.INotificationModuleService"
},
{
"filePath": "/www/apps/resources/references/order/IBigNumber/methods/order.IBigNumber.toJSON/page.mdx",
"pathname": "/references/order/IBigNumber/methods/order.IBigNumber.toJSON"
@@ -65,6 +65,14 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
"path": "/architectural-modules/cache/create",
"title": "Create Cache Module",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/cache-service",
"title": "Use Cache Module",
"children": []
}
]
}
@@ -122,6 +130,14 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
"path": "/architectural-modules/event/create",
"title": "Create Event Module",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/event-service",
"title": "Use Event Module",
"children": []
}
]
}
@@ -179,6 +195,14 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
"path": "/references/file-provider-module",
"title": "Create File Provider",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/file-service",
"title": "Use File Module",
"children": []
}
]
}
@@ -317,6 +341,14 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
"path": "/architectural-modules/notification/send-notification",
"title": "Send Notification",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/references/notification-service",
"title": "Use Notification Module",
"children": []
}
]
}
@@ -360,6 +392,22 @@ const generatedgeneratedArchitecturalModulesSidebarSidebar = {
"children": []
}
]
},
{
"loaded": true,
"isPathHref": true,
"type": "sub-category",
"title": "Guides",
"children": [
{
"loaded": true,
"isPathHref": true,
"type": "link",
"path": "/architectural-modules/workflow-engine/how-to-use",
"title": "Use Workflow Engine Module",
"children": []
}
]
}
]
}
@@ -142,6 +142,30 @@ const generatedgeneratedHowToTutorialsSidebarSidebar = {
"path": "https://docs.medusajs.com/resources/architectural-modules/notification/send-notification",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Use Cache Module",
"path": "https://docs.medusajs.com/resources/references/cache-service",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Use Event Module",
"path": "https://docs.medusajs.com/resources/references/event-service",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Use File Module",
"path": "https://docs.medusajs.com/resources/references/file-service",
"children": []
},
{
"loaded": true,
"isPathHref": true,
@@ -149,6 +173,22 @@ const generatedgeneratedHowToTutorialsSidebarSidebar = {
"title": "Use Locking Module",
"path": "https://docs.medusajs.com/resources/references/locking-service",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Use Notification Module",
"path": "https://docs.medusajs.com/resources/references/notification-service",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"type": "ref",
"title": "Use Workflow Engine Module",
"path": "https://docs.medusajs.com/resources/architectural-modules/workflow-engine/how-to-use",
"children": []
}
]
},
@@ -149,6 +149,11 @@ export const slugChanges = [
"newSlug": "/references/auth/provider",
"filePath": "/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx"
},
{
"origSlug": "/references/cache/interfaces/cache.ICacheService",
"newSlug": "/references/cache-service",
"filePath": "/www/apps/resources/references/cache/interfaces/cache.ICacheService/page.mdx"
},
{
"origSlug": "/references/cart/ICartModuleService/methods/cart.ICartModuleService.addLineItemAdjustments",
"newSlug": "/references/cart/addLineItemAdjustments",
@@ -3734,11 +3739,21 @@ export const slugChanges = [
"newSlug": "/references/data-model/define",
"filePath": "/www/apps/resources/references/dml/entity_builder/EntityBuilder/methods/dml.entity_builder.EntityBuilder.define/page.mdx"
},
{
"origSlug": "/references/event/interfaces/event.IEventBusModuleService",
"newSlug": "/references/event-service",
"filePath": "/www/apps/resources/references/event/interfaces/event.IEventBusModuleService/page.mdx"
},
{
"origSlug": "/references/file/classes/file.AbstractFileProviderService",
"newSlug": "/references/file-provider-module",
"filePath": "/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx"
},
{
"origSlug": "/references/file_service/interfaces/file_service.IFileModuleService",
"newSlug": "/references/file-service",
"filePath": "/www/apps/resources/references/file_service/interfaces/file_service.IFileModuleService/page.mdx"
},
{
"origSlug": "/references/fulfillment/IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.calculateShippingOptionsPrices",
"newSlug": "/references/fulfillment/calculateShippingOptionsPrices",
@@ -4829,6 +4844,11 @@ export const slugChanges = [
"newSlug": "/references/notification-provider-module",
"filePath": "/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx"
},
{
"origSlug": "/references/notification_service/interfaces/notification_service.INotificationModuleService",
"newSlug": "/references/notification-service",
"filePath": "/www/apps/resources/references/notification_service/interfaces/notification_service.INotificationModuleService/page.mdx"
},
{
"origSlug": "/references/order/IOrderModuleService/methods/order.IOrderModuleService.addOrderAction",
"newSlug": "/references/order/addOrderAction",