docs: fixes following QA testing (#9690)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-10-22 18:20:21 +03:00
1 parent b2122c4073
commit 731309e87a
40 files changed
+70 -66

No files matched your search

@@ -61,4 +61,4 @@ Then, open a product’s details page in the Medusa Admin. You’ll find your cu
## Admin Components List
To build admin customizations that match the Medusa Admin's designs and layouts, refer to [this guide](!resources!/admin-component) to find common components.
To build admin customizations that match the Medusa Admin's designs and layouts, refer to [this guide](!resources!/admin-components) to find common components.
@@ -40,7 +40,7 @@ export const config: SubscriberConfig = {
A subscriber file must export:
- A subscriber function that is an asynchronous function executed whenever the associated event is triggered.
- An asynchronous subscriber function that's executed whenever the associated event is triggered.
- A configuration object defining the event this subscriber is listening to.
The above subscriber listens to the `product.created` event. Whenever the event is emitted, it logs in the terminal `A product is created`.
@@ -10,7 +10,7 @@ In this chapter, you’ll learn about loaders and how to use them.
A loader is a function executed when the Medusa application starts. You define and export it in a module.
Loaders are useful to perform a task at the application start-up, such as to sync data between Medusa and a third-pary service.
Loaders are useful to perform a task at the application start-up, such as to sync data between Medusa and a third-party service.
---
@@ -58,7 +58,7 @@ Data models automatically have the date properties `created_at`, `updated_at`, a
### 2. Create Service
A module must define a service that implements its functionalities, such as manage the records of your custom data models in the database.
A module must define a service that implements its functionalities, such as managing the records of your custom data models in the database.
A service is a TypeScript or JavaScript class defined in the `service.ts` file at the root of your module's directory.
@@ -140,11 +140,11 @@ module.exports = defineConfig({
})
```
Its value is an array of objects, each having a `resolve` property, whose value is either a path to module's directory, or an `npm` package’s name.
Its value is an array of objects, each having a `resolve` property, whose value is either a path to the module's directory, or an `npm` package’s name.
### 5. Generate Migrations
A migration is a TypeScript or JavaScript file that defines database changes made by your module, such as create the `my_custom` table for the `MyCustom` data model.
A migration is a TypeScript or JavaScript file that defines database changes made by your module, such as creating the `my_custom` table for the `MyCustom` data model.
To generate a migration for the data models in your module, run the following command:
@@ -160,7 +160,7 @@ The module name `helloModuleService` is the key used when registering the module
</Note>
The above command creates a migration file at the directory `src/modules/hello/migrations` similar to the following:
The above command creates a migration file in the directory `src/modules/hello/migrations` similar to the following:
```ts
import { Migration } from "@mikro-orm/migrations"
+3 -3
View File
@@ -4,15 +4,15 @@ export const metadata = {
# {metadata.title}
In the next chapters, you’ll learn about the basic concepts of Medusa that are central in your development.
In the next chapters, you’ll learn about the basic concepts of Medusa that are central to your development.
By the end of these chapter, you’ll be able to:
By the end of these chapters, you’ll be able to:
- Expose your custom functionalities through endpoints.
- Create custom modules that define custom business logic.
- Create custom tables in the database through data models.
- Execute scripts when the Medusa application starts.
- Perform asynchronus actions when an event occurs.
- Perform asynchronous actions when an event occurs.
- Run tasks at a specified time or pattern during the Medusa application's runtime.
- Create custom flows as a series of steps involving multiple services.
- Customize the admin dashboard to inject components on existing pages or add new pages.
@@ -267,4 +267,4 @@ const myWorkflow = createWorkflow(
export default myWorkflow
```
In the step, you resolve the Product Module's main service and use it to retrieve the product count.
In `step1`, you resolve the Product Module's main service and use it to retrieve the product count.