MSI-1861 extend README files for all inventory modules #1871
Conversation
|
@keharper and I will look these over! Thanks for writing readme content! |
|
Kevin is reviewing, and committing edits directly. I'll review after his commits are complete. |
There was a problem hiding this comment.
All work looks great! Thanks for working through these and updating content, @vadimjustus
and @keharper !
remove extra "module" from description
app/code/Magento/Inventory/README.md
Outdated
|
|
||
| ## Installation details | ||
|
|
||
| This module is installed as part of Magento Open Source. It cannot be deleted or disabled. |
There was a problem hiding this comment.
This is not really correct for MSI modules, especially that all the MSI modules are disabled for merchants who make upgrade 2.1, 2.2 -> 2.3 + MSI
app/code/Magento/Inventory/README.md
Outdated
| **Inventory** provides implementation for inventory management. | ||
| See [concept documentation](https://github.com/magento-engcom/magento2/wiki/Technical-Vision.-Catalog-Inventory) | ||
| for further information. | ||
| The `Inventory` module is part of the MSI (Multi-Source Inventory) project, |
There was a problem hiding this comment.
I would re-phrase
MSI (Multi-Source Inventory) project -> New Inventory infrastructure.
It's better to avoid usage of MSI, and start calling new modules as new Inventory
app/code/Magento/Inventory/README.md
Outdated
| ## Extension points and service contracts | ||
|
|
||
| All public interfaces related to this module are located in the `InventoryApi` module. | ||
| Use the interfaces defined in `InventoryApi` to extend this module. |
There was a problem hiding this comment.
Ideally to have an explicit statement here, that we don't recommend to use/refer classes and other entities from this module in other modules, interfaces and extension points from InventoryApi should be used for these purposes
|
|
||
| ## Additional information | ||
|
|
||
| The `InventoryShipping` module defines the following events: |
There was a problem hiding this comment.
it does not define events, it provides listeners/handlers for these events.
Consumers are not APIs
|
|
Description (*)
Extend README files in all inventory modules.
Fixed Issues (if relevant)
Contribution checklist (*)