docs: updates for breaking changes (#9558)

- Update modules registration
- Update `medusa-config.js` to `medusa-config.ts`
- Update the out directory in the admin deployment guide
- Update logger imports
- Other fixes

Note: will need to re-generate references afterwards

Closes #9548
This commit is contained in:
Shahed Nasser
2024-10-14 10:40:30 +00:00
committed by GitHub
parent 2a9fc0e514
commit b6df24463d
53 changed files with 319 additions and 324 deletions
@@ -48,17 +48,17 @@ export default {
This exports the module's definition, indicating that the \`MyAuthProviderService\` is the module's service.`,
`## 4. Use Module
To use your Auth Module Provider, add it to the \`providers\` array of the Auth Module:
To use your Auth Module Provider, add it to the \`providers\` array of the Auth Module in \`medusa-config.ts\`:
\`\`\`js title="medusa-config.js"
const { Modules } = require("@medusajs/framework/utils")
\`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: {
[Modules.AUTH]: {
modules: [
{
resolve: "@medusajs/framework/auth",
options: {
providers: [
@@ -72,7 +72,7 @@ module.exports = defineConfig({
],
},
},
}
]
})
\`\`\`
`,
@@ -48,7 +48,7 @@ export default {
This exports the module's definition, indicating that the \`MyFileProviderService\` is the module's service.`,
`## 4. Use Module
To use your File Module Provider, add it to the \`providers\` array of the File Module:
To use your File Module Provider, add it to the \`providers\` array of the File Module in \`medusa-config.ts\`:
<Note>
@@ -56,15 +56,15 @@ The File Module accepts one provider only.
</Note>
\`\`\`js title="medusa-config.js"
const { Modules } = require("@medusajs/framework/utils")
\`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: {
[Modules.FILE]: {
modules: [
{
resolve: "@medusajs/framework/file",
options: {
providers: [
@@ -78,7 +78,7 @@ module.exports = defineConfig({
],
},
},
}
]
})
\`\`\`
`,
@@ -48,17 +48,17 @@ export default {
This exports the module's definition, indicating that the \`MyFulfillmentProviderService\` is the module's service.`,
`## 4. Use Module
To use your Fulfillment Module Provider, add it to the \`providers\` array of the Fulfillment Module:
To use your Fulfillment Module Provider, add it to the \`providers\` array of the Fulfillment Module in \`medusa-config.ts\`:
\`\`\`js title="medusa-config.js"
const { Modules } = require("@medusajs/framework/utils")
\`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: {
[Modules.FULFILLMENT]: {
modules: [
{
resolve: "@medusajs/framework/fulfillment",
options: {
providers: [
@@ -72,7 +72,7 @@ module.exports = defineConfig({
],
},
},
}
]
})
\`\`\`
`,
@@ -9,7 +9,7 @@ const medusaConfigOptions: FormattingOptionsType = {
frontmatterData: {
slug: "/references/medusa-config",
},
reflectionDescription: `In this document, youll learn how to create a file service in the Medusa backend and the methods you must implement in it.`,
reflectionDescription: `In this document, youll learn how to create a file service in the Medusa application and the methods you must implement in it.`,
reflectionTitle: {
fullReplacement: "Configure Medusa Backend",
},
@@ -52,7 +52,7 @@ export default {
This exports the module's definition, indicating that the \`MyNotificationProviderService\` is the module's service.`,
`## 4. Use Module
To use your Notification Module Provider, add it to the \`providers\` array of the Notification Module:
To use your Notification Module Provider, add it to the \`providers\` array of the Notification Module in \`medusa-config.ts\`:
<Note>
@@ -60,15 +60,15 @@ The Notification Module accepts one provider per channel.
</Note>
\`\`\`js title="medusa-config.js"
const { Modules } = require("@medusajs/framework/utils")
\`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: {
[Modules.NOTIFICATION]: {
modules: [
{
resolve: "@medusajs/framework/notification",
options: {
providers: [
@@ -83,7 +83,7 @@ module.exports = defineConfig({
],
},
},
}
]
})
\`\`\`
@@ -57,17 +57,17 @@ export default {
This exports the module's definition, indicating that the \`MyPaymentProviderService\` is the module's service.`,
`## 4. Use Module
To use your Payment Module Provider, add it to the \`providers\` array of the Payment Module:
To use your Payment Module Provider, add it to the \`providers\` array of the Payment Module in \`medusa-config.ts\`:
\`\`\`js title="medusa-config.js"
const { Modules } = require("@medusajs/framework/utils")
\`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: {
[Modules.PAYMENT]: {
modules: [
{
resolve: "@medusajs/framework/payment",
options: {
providers: [
@@ -82,7 +82,7 @@ module.exports = defineConfig({
]
}
}
}
]
})
\`\`\`
`,