docs: update imports and package names across docs (#9375)

* docs: update imports and package names across docs
+ reference configs

* generate files

* fix import

* change preview to rc
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-10-01 11:03:42 +02:00
1 parent c726ed54f5
commit 2e16949979
196 files changed
+1379 -1491

No files matched your search

@@ -16,27 +16,15 @@ The Local File Module Provider is only for development purposes. Use the [S3 Fil
---
## Install the Local File Module
## Register the Local File Module
<Note>
The Local File Module is installed by default in your application.
The Local File Module Provider is registered by default in your application.
</Note>
To install the Local File Module Provider, run the following command in the directory of your Medusa application:
```bash npm2yarn
npm install @medusajs/file-local-next@preview
```
<Note>
Make sure that the version added in `package.json` is `preview` to avoid errors with installation and updates in the future.
</Note>
Next, add the module into the `providers` array of the File Module:
Add the module into the `providers` array of the File Module:
<Note>
@@ -45,7 +33,7 @@ The File Module accepts one provider only.
</Note>
```js title="medusa-config.js"
const { Modules } = require("@medusajs/utils")
const { Modules } = require("@medusajs/framework/utils")
// ...
@@ -53,11 +41,11 @@ module.exports = {
// ...
modules: {
[Modules.FILE]: {
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...
@@ -102,15 +102,9 @@ The S3 File Module Provider integrates Amazon S3 and services following a compat
---
## Install the S3 File Module
## Register the S3 File Module
To install the S3 File Module Provider, run the following command in the directory of your Medusa application:
```bash npm2yarn
npm install @medusajs/file-s3@preview
```
Next, add the module into the `providers` array of the File Module:
Add the module into the `providers` array of the File Module:
<Note>
@@ -119,7 +113,7 @@ The File Module accepts one provider only.
</Note>
```js title="medusa-config.js"
const { Modules } = require("@medusajs/utils")
const { Modules } = require("@medusajs/framework/utils")
// ...
@@ -128,11 +122,11 @@ module.exports = {
modules: {
// ...
[Modules.FILE]: {
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,
@@ -360,11 +354,11 @@ module.exports = defineConfig({
// ...
modules: {
[Modules.FILE]: {
resolve: "@medusajs/file",
resolve: "@medusajs/medusa/file",
options: {
providers: [
{
resolve: "@medusajs/file-s3",
resolve: "@medusajs/medusa/file-s3",
id: "s3",
options: {
// ...