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
@@ -26,21 +26,21 @@ Only one provider can be defined for a 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]: {
resolve: "@medusajs/medusa/notification",
modules: [
{
resolve: "@medusajs/notification",
options: {
providers: [
// ...
{
resolve: "@medusajs/medusa/notification-local",
resolve: "@medusajs/notification-local",
id: "local",
options: {
channels: ["email"],
@@ -49,7 +49,7 @@ module.exports = defineConfig({
],
},
},
},
]
})
```
@@ -30,22 +30,22 @@ When you send a notification, you specify the channel to send it through, such a
For example:
```js title="medusa-config.js" highlights={[["19"]]}
const { Modules } = require("@medusajs/framework/utils")
```ts title="medusa-config.ts" highlights={[["19"]]}
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = {
// ...
modules: {
modules: [
// ...
[Modules.NOTIFICATION]: {
resolve: "@medusajs/medusa/notification",
{
resolve: "@medusajs/notification",
options: {
providers: [
// ...
{
resolve: "@medusajs/medusa/notification-local",
resolve: "@medusajs/notification-local",
id: "notification",
options: {
channels: ["email"],
@@ -54,7 +54,7 @@ module.exports = {
],
},
},
},
]
}
```
@@ -37,21 +37,21 @@ Only one provider can be defined for a 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]: {
resolve: "@medusajs/medusa/notification",
modules: [
{
resolve: "@medusajs/notification",
options: {
providers: [
// ...
{
resolve: "@medusajs/medusa/notification-sendgrid",
resolve: "@medusajs/notification-sendgrid",
id: "sendgrid",
options: {
channels: ["email"],
@@ -62,7 +62,7 @@ module.exports = defineConfig({
],
},
},
},
]
})
```