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
@@ -22,17 +22,19 @@ The In-Memory Workflow Engine Module is registered by default in your applicatio
</Note>
Add the module into the `modules` property of the exported object in `medusa-config.js`:
Add the module into the `modules` property of the exported object 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.WORKFLOW_ENGINE]: true,
},
modules: [
{
resolve: "@medusajs/workflow-engine-inmemory"
}
],
})
```
@@ -19,21 +19,21 @@ The Redis Workflow Engine Module uses Redis to track workflow executions and han
}
]} />
Add the module into the `modules` property of the exported object in `medusa-config.js`:
Add the module into the `modules` property of the exported object in `medusa-config.ts`:
export const highlights = [
["12", "url", "The Redis connection URL."]
]
```js title="medusa-config.js" highlights={highlights}
const { Modules } = require("@medusajs/framework/utils")
```ts title="medusa-config.ts" highlights={highlights}
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: {
[Modules.WORKFLOW_ENGINE]: {
modules: [
{
resolve: "@medusajs/workflow-engine-redis",
options: {
redis: {
@@ -41,7 +41,7 @@ module.exports = defineConfig({
},
},
},
},
]
})
```