Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MSI-1861 extend README files for all inventory modules #1871

Merged
merged 94 commits into from
Nov 8, 2018
Merged
Show file tree
Hide file tree
Changes from 91 commits
Commits
Show all changes
94 commits
Select commit Hold shift + click to select a range
7485657
MSI-1861: Extend README files for all inventory modules
vadimjustus Nov 2, 2018
2aaf922
Update README.md
keharper Nov 5, 2018
064cc70
Update README.md
keharper Nov 5, 2018
4733194
Update README.md
keharper Nov 5, 2018
ea04be9
Update README.md
keharper Nov 5, 2018
b6407e3
Update README.md
keharper Nov 5, 2018
4dabd5c
Update README.md
keharper Nov 5, 2018
9d9aa81
Update README.md
keharper Nov 5, 2018
1690dfb
Update README.md
keharper Nov 5, 2018
3411396
Update README.md
keharper Nov 5, 2018
513369c
Update README.md
keharper Nov 5, 2018
b78f64e
Update README.md
keharper Nov 5, 2018
1e235bb
Update README.md
keharper Nov 5, 2018
81d0b2d
Update README.md
keharper Nov 5, 2018
e64ec28
Update README.md
keharper Nov 6, 2018
e15063b
Update README.md
keharper Nov 6, 2018
58ac40c
Update README.md
keharper Nov 6, 2018
58ba5cf
Update README.md
keharper Nov 6, 2018
7e72244
Update README.md
keharper Nov 6, 2018
5f1d589
Update README.md
keharper Nov 6, 2018
4f18edd
Update README.md
keharper Nov 6, 2018
d342dc5
Update README.md
keharper Nov 6, 2018
3b8100a
Update README.md
keharper Nov 6, 2018
e2c25f0
Update README.md
keharper Nov 6, 2018
7e72e2e
Update README.md
keharper Nov 6, 2018
723688f
Update README.md
keharper Nov 6, 2018
e1d77dd
Update README.md
keharper Nov 6, 2018
d516a82
Update README.md
keharper Nov 6, 2018
9e7bffd
Update README.md
keharper Nov 6, 2018
246b234
Update README.md
keharper Nov 6, 2018
ec812dc
Update README.md
keharper Nov 6, 2018
c209693
Update README.md
keharper Nov 6, 2018
c272493
Update README.md
keharper Nov 6, 2018
c2adec4
Update README.md
keharper Nov 6, 2018
533d7bd
Update README.md
keharper Nov 6, 2018
9d70b0a
Update README.md
keharper Nov 6, 2018
31bc1ce
Update README.md
keharper Nov 6, 2018
39cfd15
Update README.md
keharper Nov 6, 2018
b724d57
Update README.md
keharper Nov 6, 2018
c6c851c
Update README.md
keharper Nov 6, 2018
7b11607
Update README.md
keharper Nov 6, 2018
dae2cea
Update README.md
keharper Nov 6, 2018
aec58ac
Update README.md
keharper Nov 6, 2018
10c0fea
Update README.md
keharper Nov 6, 2018
a57c29b
Update README.md
keharper Nov 6, 2018
47db132
Update README.md
keharper Nov 6, 2018
35163e1
Update README.md
keharper Nov 6, 2018
7e57b0f
Update README.md
keharper Nov 6, 2018
881bffb
Update README.md
keharper Nov 6, 2018
2f6305e
Update README.md
keharper Nov 6, 2018
a97fae2
Update README.md
keharper Nov 6, 2018
5fe5f2c
Add title word
Nov 6, 2018
a33abf2
Fix link
Nov 6, 2018
067bc98
fix link
Nov 6, 2018
f7e4087
fix link
Nov 6, 2018
8b74006
Update README.md
keharper Nov 6, 2018
ead63b0
Update README.md
keharper Nov 6, 2018
90cf518
Update README.md
keharper Nov 6, 2018
d62c983
Update README.md
keharper Nov 6, 2018
bdb963c
Update README.md
keharper Nov 6, 2018
b4ccce6
Update README.md
keharper Nov 6, 2018
23d89fb
Update README.md
keharper Nov 6, 2018
53dddbf
Update README.md
keharper Nov 6, 2018
c7bca4c
Update README.md
keharper Nov 6, 2018
e7dd108
Update README.md
keharper Nov 6, 2018
fd5326a
Update README.md
keharper Nov 6, 2018
3d38278
Update README.md
keharper Nov 6, 2018
eb9bf3e
Update README.md
keharper Nov 6, 2018
16fa220
Update README.md
keharper Nov 6, 2018
73c3fee
Update README.md
keharper Nov 6, 2018
b7d943a
Update README.md
keharper Nov 6, 2018
024aca6
Update README.md
keharper Nov 6, 2018
1b0a5d3
Update README.md
keharper Nov 6, 2018
0fabf63
Update README.md
keharper Nov 6, 2018
deb07f1
Update README.md
keharper Nov 6, 2018
9cb49ba
Update README.md
keharper Nov 6, 2018
b4b560c
Update README.md
keharper Nov 6, 2018
7fb4cdd
Update README.md
keharper Nov 6, 2018
dd2119c
Update README.md
keharper Nov 6, 2018
2573651
Update README.md
keharper Nov 6, 2018
98d10ac
Update README.md
keharper Nov 6, 2018
720bac8
Update README.md
keharper Nov 6, 2018
a9d348f
Update README.md
keharper Nov 6, 2018
d5c6af6
Update README.md
keharper Nov 6, 2018
5631cd2
Update README.md
keharper Nov 6, 2018
ece9145
Update README.md
keharper Nov 6, 2018
8ef2219
Update README.md
keharper Nov 6, 2018
d221d77
Update README.md
keharper Nov 6, 2018
4a09241
Update README.md
keharper Nov 6, 2018
a947375
Update README.md
keharper Nov 6, 2018
6c51153
Update README.md
keharper Nov 6, 2018
de0e48c
Update Readme.md
maghamed Nov 7, 2018
8405ead
Update README.md
keharper Nov 7, 2018
ba83dd7
MSI-1861: Add content to MSI README files
maghamed Nov 8, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 20 additions & 4 deletions app/code/Magento/Inventory/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Inventory
# Inventory module

**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 module is part of the MSI (Multi-Source Inventory) project,
which replaces the legacy `CatalogInventory` module with new and expanded features and APIs for Inventory Management.

The [Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

All Inventory Management modules follow the
[Single Responsibility Principle](https://en.wikipedia.org/wiki/Single_responsibility_principle).
[Inventory management architecture](https://devdocs.magento.com/guides/v2.3/inventory/architecture.html)
provides additional insight about the overall structure of these modules.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


## 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

26 changes: 22 additions & 4 deletions app/code/Magento/InventoryAdminUi/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# InventoryAdminUi
# InventoryAdminUi module

**InventoryAdminUi** provides implementation for inventory management interface.
See [concept documentation](https://github.com/magento-engcom/magento2/wiki/Technical-Vision.-Catalog-Inventory)
for further information.
The `InventoryAdminUi` module extends the Magento Admin UI to add Inventory Management functionality.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. You can remove it if you run a headless version of Magento.

## Extensibility

The `InventoryAdminUi` module contains several extension points.

### Layouts

You can extend and override layouts defined in the `view/adminhtml/layout` directory.

### UI Components

The `view/adminhtml/ui_component` directory contains extensible UI components.
26 changes: 22 additions & 4 deletions app/code/Magento/InventoryApi/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# InventoryApi
# InventoryApi module

**InventoryApi** provides interfaces for inventory management.
See [concept documentation](https://github.com/magento-engcom/magento2/wiki/Technical-Vision.-Catalog-Inventory)
for further information.
The `InventoryApi` module provides Inventory Management service contracts.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extensibility

The `InventoryApi` module contains several extension points.

### Public APIs

Public APIs are defined in the `Api` and `Api/Data` directories.

### REST endpoints

The `etc/webapi.xml` file defines endpoints for managing sources, stocks, stock source links, and source items.
16 changes: 15 additions & 1 deletion app/code/Magento/InventoryBundleProduct/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# InventoryBundleProduct
# InventoryBundleProduct module

The `InventoryBundleProduct` module integrates inventory management business logic into Magento's bundle product logic.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extension points and service contracts

There are no extension points or service contracts for this module.
16 changes: 15 additions & 1 deletion app/code/Magento/InventoryBundleProductAdminUi/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# InventoryBundleProductAdminUi
# InventoryBundleProductAdminUi module

The `InventoryBundleProductAdminUi`extends the Magento Admin UI to add MSI functionality.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. You can remove it if you run a headless version of Magento.

## Extensibility

There are no extension points or for this module.
15 changes: 13 additions & 2 deletions app/code/Magento/InventoryCache/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# Inventory
# InventoryCache module

**InventoryCache**
The `InventoryCache` module integrates inventory management business logic into Magento's cache logic.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extension points and service contracts

There are no extension points or service contracts for this module.
18 changes: 14 additions & 4 deletions app/code/Magento/InventoryCatalog/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# InventoryCatalog

**InventoryCatalog** provides implementation for bridge between **Inventory** and **Catalog**.
This is dedicated module which add logic to Default Role of the Source on installations with single source/stock.
See [concept documentation](https://github.com/magento-engcom/magento2/wiki/Technical-Vision.-Catalog-Inventory)
for further information.
The `InventoryCatalog` module integrates inventory management business logic into Magento's catalog logic.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extension points and service contracts

All public interfaces related to this module are located in the `InventoryCatalogApi` module.
Use the interfaces defined in `InventoryCatalogApi` to extend this module.
23 changes: 22 additions & 1 deletion app/code/Magento/InventoryCatalogAdminUi/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,23 @@
# InventoryCatalogAdminUi
# InventoryCatalogAdminUi module

The `InventoryCatalogAdminUi` module extends the Magento Admin UI to add MSI functionality.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. You can remove it if you run a headless version of Magento.

## Extensibility

The `InventoryCatalogAdminUi` module contains several extension points.

### Layouts

You can extend and override layouts defined in the `view/adminhtml/layout` directory.

### UI Components

The `view/adminhtml/ui_component` directory contains extensible UI components.
27 changes: 22 additions & 5 deletions app/code/Magento/InventoryCatalogApi/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
# InventoryCatalog
# InventoryCatalogApi module

**InventoryCatalog** provides implementation for bridge between **Inventory** and **Catalog**.
This is dedicated module which add logic to Default Role of the Source on installations with single source/stock.
See [concept documentation](https://github.com/magento-engcom/magento2/wiki/Technical-Vision.-Catalog-Inventory)
for further information.
The `InventoryCatalogApi` module provides service contracts for default source and stock providers as well as bulk operations.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extensibility

The `InventoryCatalogApi` module contains several extension points.

### Public APIs

Public APIs are defined in the `Api` directory.

### REST endpoints

The `etc/webapi.xml` file defines endpoints for assigning, unassigning, and transferring sources in bulk.
16 changes: 14 additions & 2 deletions app/code/Magento/InventoryCatalogSearch/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# InventoryCatalogSearch
# InventoryCatalogSearch module

**InventoryCatalogSearch** adapts CatalogSearch to proper work with Inventory.
The `InventoryCatalogSearch` module integrates inventory management business logic into Magento's search logic.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extension points and service contracts

There are no extension points or service contracts for this module.
16 changes: 15 additions & 1 deletion app/code/Magento/InventoryConfigurableProduct/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# InventoryConfigurableProduct
## InventoryConfigurableProduct module

The `InventoryConfigurableProduct` module integrates inventory management business logic into Magento's configurable product logic.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extension points and service contracts

There are no extension points or service contracts for this module.
20 changes: 19 additions & 1 deletion app/code/Magento/InventoryConfigurableProductAdminUi/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
# InventoryConfigurableProductAdminUi
# InventoryConfigurableProductAdminUi module

The `InventoryConfigurableProductAdminUi`extends the Magento Admin UI to add inventory management functionality.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. You can remove it if you run a headless version of Magento.

## Extensibility

The `InventoryConfigurableProductAdminUi` module contains several extension points.

### UI Components

The `view/adminhtml/ui_component` directory contains extensible UI components.
16 changes: 15 additions & 1 deletion app/code/Magento/InventoryConfigurableProductIndexer/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# InventoryConfigurableProductIndexer
# InventoryConfigurableProductIndexer module

The `InventoryConfigurableProductIndexer` module integrates inventory management business logic into Magento's indexation logic for configurable products.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extension points and service contracts

There are no extension points or service contracts for this module.
17 changes: 16 additions & 1 deletion app/code/Magento/InventoryConfiguration/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,16 @@
# InventoryConfiguration
# InventoryConfiguration module

The `InventoryConfiguration` module implements logic for inventory management configuration.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extension points and service contracts

All public interfaces related to this module are located in the `InventoryConfigurationApi` module.
Use the interfaces defined in `InventoryConfigurationApi` to extend this module.
20 changes: 19 additions & 1 deletion app/code/Magento/InventoryConfigurationApi/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
# InventoryConfigurationApi
# InventoryConfigurationApi module

The `InventoryConfigurationApi` module provides service contracts for inventory management configuration.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be disabled.

## Extensibility

The `InventoryConfigurationApi` module contains several extension points.

### Public APIs

Public APIs are defined in the `Api` and `Api/Data` directories.
16 changes: 15 additions & 1 deletion app/code/Magento/InventoryGroupedProduct/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# InventoryGroupedProduct
# InventoryGroupedProduct module

The `InventoryGroupedProduct` module integrates inventory management business logic into Magento's grouped product logic.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extension points and service contracts

There are no extension points or service contracts for this module.
16 changes: 15 additions & 1 deletion app/code/Magento/InventoryGroupedProductAdminUi/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# InventoryGroupedProductAdminUi
# InventoryGroupedProductAdminUi module

The `InventoryGroupedProductAdminUi` module extends Magento's admin UI with inventory management functionality.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. You can remove it if you run a headless version of Magento.

## Extension points and service contracts

There are no extension points or service contracts for this module.
16 changes: 15 additions & 1 deletion app/code/Magento/InventoryGroupedProductIndexer/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# InventoryGroupedProductIndexer
# InventoryGroupedProductIndexer module

The `InventoryGroupedProductIndexer` module integrates inventory management business logic into Magento's indexation logic for grouped products.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extension points and service contracts

There are no extension points or service contracts for this module.
23 changes: 18 additions & 5 deletions app/code/Magento/InventoryImportExport/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
# InventoryCatalog
# InventoryImportExport module

**InventoryCatalog** provides implementation for bridge between **Inventory** and **Catalog**.
This is dedicated module which add logic to Default Role of the Source on installations with single source/stock.
See [concept documentation](https://github.com/magento-engcom/magento2/wiki/Technical-Vision.-Catalog-Inventory)
for further information.
The `InventoryImportExport` module provides compatibility between Magento's flat file import/export logic and Inventory Management.

This module is part of the MSI (Multi-Source Inventory) project. The
[Inventory Management overview](https://devdocs.magento.com/guides/v2.3/inventory/index.html)
describes the MSI project in more detail.

## Installation details

This module is installed as part of Magento Open Source. It cannot be deleted or disabled.

## Extension points and service contracts

There are no extension points or service contracts for this module.

## Additional information

The `files/sample/stock_sources.csv` file is a template for importing inventory into the system.