docs: updates to use DML and other changes (#7834)

- Change existing data model guides and add new ones for DML
- Change module's docs around service factory + remove guides that are now necessary
- Hide/remove all mentions of module relationships, or label them as coming soon.
- Change all data model creation snippets to use DML
- use `property` instead of `field` when referring to a data model's properties.
- Fix all snippets in commerce module guides to use new method suffix (no more main model methods)
- Rework recipes, removing/hiding a lot of sections as a lot of recipes are incomplete with the current state of DML.


### Other changes

- Highlight fixes in some guides
- Remove feature flags guide
- Fix code block styles when there are no line numbers.

### Upcoming changes in other PRs

- Re-generate commerce module references (for the updates in the method names)
- Ensure that the data model references are generated correctly for models using DML.
- (probably at a very later point) revisit recipes
This commit is contained in:
Shahed Nasser
2024-06-26 07:55:59 +00:00
committed by GitHub
parent 62dacdda75
commit 0462cc5acf
126 changed files with 1808 additions and 14242 deletions
@@ -27,14 +27,15 @@ Some use case examples for using a sales channel:
Manage sales channels in your store. Each sales channel has different meta information such as name or description, allowing you to easily differentiate between sales channels.
```ts
const salesChannels = await salesChannelModuleService.create([
{
name: "B2B",
},
{
name: "Mobile App",
},
])
const salesChannels = await salesChannelModuleService
.createSalesChannels([
{
name: "B2B",
},
{
name: "Mobile App",
},
])
```
### Product Availability
@@ -73,7 +74,8 @@ For example:
request.scope.resolve(ModuleRegistrationName.SALES_CHANNEL)
res.json({
sales_channels: await salesChannelModuleService.list(),
sales_channels: await salesChannelModuleService
.listSalesChannels(),
})
}
```
@@ -92,7 +94,8 @@ For example:
const salesChannelModuleService: ISalesChannelModuleService =
container.resolve(ModuleRegistrationName.SALES_CHANNEL)
const salesChannels = await salesChannelModuleService.list()
const salesChannels = await salesChannelModuleService
.listSalesChannels()
}
```
@@ -112,7 +115,8 @@ For example:
ModuleRegistrationName.SALES_CHANNEL
)
const salesChannels = await salesChannelModuleService.list()
const salesChannels = await salesChannelModuleService
.listSalesChannels()
})
```