docs: fix package names in module registration (#9590)

* docs: fix package names in module registration

* update references
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-10-16 09:05:07 +02:00
1 parent 813efeae51
commit 6efb5897dc
27 files changed
+60 -71

No files matched your search

@@ -32,7 +32,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/cache-inmemory",
resolve: "@medusajs/medusa/cache-inmemory",
options: {
// optional options
},
@@ -34,7 +34,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/cache-redis",
resolve: "@medusajs/medusa/cache-redis",
options: {
redisUrl: process.env.CACHE_REDIS_URL,
},
@@ -31,7 +31,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/event-bus-local"
resolve: "@medusajs/medusa/event-bus-local"
}
]
})
@@ -38,7 +38,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/event-bus-redis",
resolve: "@medusajs/medusa/event-bus-redis",
options: {
redisUrl: process.env.EVENTS_REDIS_URL,
},
@@ -41,11 +41,11 @@ module.exports = {
// ...
modules: [
{
resolve: "@medusajs/file",
resolve: "@medusajs/medusa/file",
options: {
providers: [
{
resolve: "@medusajs/file-local-next",
resolve: "@medusajs/medusa/file-local-next",
id: "local",
options: {
// provider options...
@@ -122,11 +122,11 @@ module.exports = {
modules: [
// ...
{
resolve: "@medusajs/file",
resolve: "@medusajs/medusa/file",
options: {
providers: [
{
resolve: "@medusajs/file-s3",
resolve: "@medusajs/medusa/file-s3",
id: "s3",
options: {
file_url: process.env.S3_FILE_URL,
@@ -354,11 +354,11 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/file",
resolve: "@medusajs/medusa/file",
options: {
providers: [
{
resolve: "@medusajs/file-s3",
resolve: "@medusajs/medusa/file-s3",
id: "s3",
options: {
// ...
@@ -35,12 +35,12 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/notification",
resolve: "@medusajs/medusa/notification",
options: {
providers: [
// ...
{
resolve: "@medusajs/notification-local",
resolve: "@medusajs/medusa/notification-local",
id: "local",
options: {
channels: ["email"],
@@ -40,12 +40,12 @@ module.exports = {
modules: [
// ...
{
resolve: "@medusajs/notification",
resolve: "@medusajs/medusa/notification",
options: {
providers: [
// ...
{
resolve: "@medusajs/notification-local",
resolve: "@medusajs/medusa/notification-local",
id: "notification",
options: {
channels: ["email"],
@@ -46,12 +46,12 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/notification",
resolve: "@medusajs/medusa/notification",
options: {
providers: [
// ...
{
resolve: "@medusajs/notification-sendgrid",
resolve: "@medusajs/medusa/notification-sendgrid",
id: "sendgrid",
options: {
channels: ["email"],
@@ -33,7 +33,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/workflow-engine-inmemory"
resolve: "@medusajs/medusa/workflow-engine-inmemory"
}
],
})
@@ -34,7 +34,7 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/workflow-engine-redis",
resolve: "@medusajs/medusa/workflow-engine-redis",
options: {
redis: {
url: process.env.WE_REDIS_URL,
@@ -35,11 +35,11 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/auth",
resolve: "@medusajs/medusa/auth",
options: {
providers: [
{
resolve: "@medusajs/auth-emailpass",
resolve: "@medusajs/medusa/auth-emailpass",
id: "emailpass",
options: {
// provider options...
@@ -29,11 +29,11 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/fulfillment",
resolve: "@medusajs/medusa/fulfillment",
options: {
providers: [
{
resolve: `@medusajs/fulfillment-manual`,
resolve: `@medusajs/medusa/fulfillment-manual`,
id: "manual",
options: {
// provider options...
@@ -112,11 +112,11 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/payment",
resolve: "@medusajs/medusa/payment",
options: {
providers: [
{
resolve: "@medusajs/payment-stripe",
resolve: "@medusajs/medusa/payment-stripe",
id: "stripe",
options: {
// ...
@@ -40,11 +40,11 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/payment",
resolve: "@medusajs/medusa/payment",
options: {
providers: [
{
resolve: "@medusajs/payment-stripe",
resolve: "@medusajs/medusa/payment-stripe",
id: "stripe",
options: {
apiKey: process.env.STRIPE_API_KEY,
@@ -121,7 +121,7 @@ So, add the following script in `package.json`:
By default, your Medusa application uses modules and providers useful for development, such as the In-Memory Cache Module or the Local File Module Provider.
It’s highly recommended to instead install modules and providers suitable for production, including:
It’s highly recommended to instead use modules and providers suitable for production, including:
- [Redis Cache Module](../../../architectural-modules/cache/redis/page.mdx)
- [Redis Event Bus Module](../../../architectural-modules/event/redis/page.mdx)
@@ -129,17 +129,6 @@ It’s highly recommended to instead install modules and providers suitable for
- [S3 File Module Provider](../../../architectural-modules/file/s3/page.mdx) (or other file module providers production-ready).
- [SendGrid Notification Module Provider](../../../architectural-modules/notification/sendgrid/page.mdx) (or other notification module providers production-ready).
For example, add the following dependencies in `package.json` for the Cache, Event Bus, and Workflow Engine modules:
```json
"dependencies": {
// ...
"@medusajs/cache-redis": "rc",
"@medusajs/event-bus-redis": "rc",
"@medusajs/workflow-engine-redis": "rc"
}
```
Then, add these modules in `medusa-config.ts`:
```ts title="medusa-config.ts"
@@ -149,19 +138,19 @@ module.exports = defineConfig({
// ...
modules: [
{
resolve: "@medusajs/cache-redis",
resolve: "@medusajs/medusa/cache-redis",
options: {
redisUrl: process.env.REDIS_URL,
},
},
{
resolve: "@medusajs/event-bus-redis",
resolve: "@medusajs/medusa/event-bus-redis",
options: {
redisUrl: process.env.REDIS_URL,
},
},
{
resolve: "@medusajs/workflow-engine-redis",
resolve: "@medusajs/medusa/workflow-engine-redis",
options: {
redis: {
url: process.env.REDIS_URL,
@@ -1512,11 +1512,11 @@ module.exports = defineConfig({
modules: [
// ...
{
resolve: "@medusajs/fulfillment",
resolve: "@medusajs/medusa/fulfillment",
options: {
providers: [
{
resolve: "@medusajs/fulfillment-manual",
resolve: "@medusajs/medusa/fulfillment-manual",
id: "manual",
},
{
@@ -2008,11 +2008,11 @@ module.exports = defineConfig({
modules: [
// ...
{
resolve: "@medusajs/notification",
resolve: "@medusajs/medusa/notification",
options: {
providers: [
{
resolve: "@medusajs/notification-local",
resolve: "@medusajs/medusa/notification-local",
id: "local",
options: {
name: "Local Notification Provider",