Skip to content

Commit

Permalink
PR improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
vlmed committed Apr 21, 2021
1 parent b01435e commit 7f1dd3f
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 45 deletions.
13 changes: 9 additions & 4 deletions app/code/Magento/ImportExport/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ The Magento_ImportExport module creates the following tables in the database:
- `importexport_importdata`
- `import_history`

All database schema changes made by this module are rolled back when the module gets disabled and setup:upgrade command is run.

For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).

## Structure
Expand All @@ -25,7 +27,7 @@ Extension developers can interact with the Magento_ImportExport module. For more

### Layouts

This module introduces the following layouts in the `view/frontend/layout` directory:
This module introduces the following layout handles in the `view/frontend/layout` directory:

- `adminhtml_export_getfilter`
- `adminhtml_export_index`
Expand All @@ -49,10 +51,13 @@ For information about a UI component in Magento 2, see [Overview of UI component
### Public APIs

- `Magento\ImportExport\Api\Data\ExportInfoInterface`
- export data
- getter and setter interface with data needed for export

- `Magento\ImportExport\Api\Data\ExtendedExportInfoInterface`
- extends `Magento\ImportExport\Api\Data\ExportInfoInterface`. Contains data for skipped attributes

- `\Magento\ImportExport\Api\ExportManagementInterface`:
- get export data
- `\Magento\ImportExport\Api\ExportManagementInterface`
- Executing actual export and returns export data

For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html).

Expand Down
29 changes: 8 additions & 21 deletions app/code/Magento/Indexer/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Magento_Indexer module

This module provides Magento Indexing functionality.
It allows:
It allows to:
- read indexers configuration
- represent indexers in admin
- regenerate indexes by cron schedule
Expand Down Expand Up @@ -43,42 +43,28 @@ The module dispatches the following events:
#### Model

- `clean_cache_by_tags` event in the `\Magento\Indexer\Model\Indexer\CacheCleaner::cleanCache` method. Parameters:
- `object` is a `$this->cacheContext` object (`Magento\Framework\Indexer\CacheContext` class)
- `object` is a `cacheContext` object (`Magento\Framework\Indexer\CacheContext` class)

#### Plugin

- `clean_cache_after_reindex` event in the `\Magento\Indexer\Model\Processor\CleanCache::afterUpdateMview` method. Parameters:
- `object` is a `$this->context` object (`Magento\Framework\Indexer\CacheContext` class)
- `object` is a `context` object (`Magento\Framework\Indexer\CacheContext` class)

- `clean_cache_by_tags` event in the `\Magento\Indexer\Model\Processor\CleanCache::afterReindexAllInvalid` method. Parameters:
- `object` is a `$this->context` object (`Magento\Framework\Indexer\CacheContext` class)
- `object` is a `context` object (`Magento\Framework\Indexer\CacheContext` class)

For information about an event in Magento 2, see [Events and observers](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events).

### Layouts

This module introduces the following layouts in the `view/adminhtml/layout` directory:
This module introduces the following layout handles in the `view/adminhtml/layout` directory:
- `indexer_indexer_list`
- `indexer_indexer_list_grid`

For more information about layouts in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/layout-overview.html).

## Additional information

### Magento indexers

List of Magento default indexers:
- `design_config_grid` - Design Config Grid
- `customer_grid` - Customer Grid
- `catalog_category_product` - Category Products
- `catalog_product_category` - Product Categories
- `catalogrule_rule` - Catalog Rule Product
- `catalog_product_attribute` - Product EAV
- `catalogrule_product` - Catalog Product Rule
- `cataloginventory_stock` - Stock
- `catalog_product_price` - Product Price
- `catalogsearch_fulltext` - Catalog Search

### Indexer modes

There are 2 modes of the Indexers:
Expand All @@ -91,11 +77,12 @@ There are 2 modes of the Indexers:
Magento_Indexers provides console commands:
- `bin/magento indexer:info` - view a list of all indexers
- `bin/magento indexer:status [indexer]` - view index status
- `bin/magento indexer:info` - view list all indexers
- `bin/magento indexer:reindex [indexer]` - run reindex
- `bin/magento indexer:reset [indexer]` - reset indexers
- `bin/magento indexer:show-mode [indexer]` - view the current indexer configuration
- `bin/magento indexer:set-mode {realtime|schedule} [indexer]` - specify the indexer configuration
- `bin/magento indexer:set-dimensions-mode [indexer]` - set indexer dimension mode
- `bin/magento indexer:show-dimensions-mode [indexer]` - set indexer dimension mode

### Cron options

Expand All @@ -108,7 +95,7 @@ Cron group configuration can be set at `etc/crontab.xml`:

More information can get at articles:
- [Learn more about indexing](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexing.html)
- [Learn more about Indexr optimization](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexer-batch.html)
- [Learn more about Indexer optimization](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexer-batch.html)
- [Learn more how to add custom indexer](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexing-custom.html)
- [Learn how to manage indexers](https://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-index.html)
- [Learn more about Index Management](https://docs.magento.com/user-guide/system/index-management.html)
14 changes: 3 additions & 11 deletions app/code/Magento/InstantPurchase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,6 @@ Extension developers can interact with the Magento_InstantPurchase module. For m

[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_InstantPurchase module.

### Layouts

This module introduces the following layouts in the `view/frontend/layout` directory:
- `catalog_product_view`
- `catalog_product_view_type_bundle`

For more information about layouts in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/layout-overview.html).

### Public APIs

- `\Magento\InstantPurchase\Model\BillingAddressChoose\BillingAddressChooserInterface`
Expand Down Expand Up @@ -57,6 +49,8 @@ For more information about layouts in Magento 2, see the [Layout documentation](

For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html).

## Additional information

### Instant purchase customization

Almost all aspects of instant purchase may be customized. See comments to classes and interfaces marked with `@api` tag.
Expand Down Expand Up @@ -89,9 +83,7 @@ Basic implementation is a good start point but it's recommended to provide own i
- `Magento\InstantPurchase\PaymentMethodIntegration\PaymentTokenFormatterInterface` - creates string that describes stored payment method. Basic implementation returns payment method name. It is highly recommended to implement own formatter.
- `Magento\InstantPurchase\PaymentMethodIntegration\PaymentAdditionalInformationProviderInterface` - allows to add some extra values to payment additional information array. Default implementation returns empty array.

## Additional information

#Prerequisites to display the Instant Purchase button
### Prerequisites to display the Instant Purchase button

1. Instant purchase enabled for a store at `Store / Configurations / Sales / Sales / Instant Purchase`
2. Customer is logged in
Expand Down
22 changes: 15 additions & 7 deletions app/code/Magento/Integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,13 @@ model for request and access token management.

## Installation

Before installing this module, note that the Magento_Integration is dependent on the following modules:
The Magento_Integration module is one of the base Magento 2 modules. You cannot disable or uninstall this module.

This module is dependent on the following modules:
- `Magento_Store`
- `Magento_User`
- `Magento_Security`

The following modules depend on this module:
- `Magento_Analytics`
- `Magento_Webapi`

The Magento_Integration module creates the following tables in the database:
- `oauth_consumer`
- `oauth_token`
Expand All @@ -37,13 +35,13 @@ The module dispatches the following events:

#### Model
- `customer_login` event in the `\Magento\Integration\Model\CustomerTokenService::createCustomerAccessToken` method. Parameters:
- `customer` is a `$customerDataObject` object (`\Magento\Customer\Api\Data\CustomerInterface` class)
- `customer` is an object (`\Magento\Customer\Api\Data\CustomerInterface` class)

For information about an event in Magento 2, see [Events and observers](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events).

### Layouts

This module introduces the following layouts in the `view/adminhtml/layout` directory:
This module introduces the following layout handles in the `view/adminhtml/layout` directory:
- `adminhtml_integration_edit`
- `adminhtml_integration_grid`
- `adminhtml_integration_grid_block`
Expand Down Expand Up @@ -79,6 +77,16 @@ For more information about a layout in Magento 2, see the [Layout documentation]
- update an Integration
- delete an Integration by integration ID
- get an array of selected resources for an integration

- `\Magento\Integration\Api\OauthServiceInterface`:
- create a new consumer account
- create access token for provided consumer
- retrieve access token assigned to the consumer
- load consumer by its ID
- load consumer by its key
- execute post to integration (consumer) HTTP Post URL. Generate and return oauth_verifier
- delete the consumer data associated with the integration including its token and nonce
- remove token associated with provided consumer

For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html).

Expand Down
12 changes: 10 additions & 2 deletions app/code/Magento/LayeredNavigation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Extension developers can interact with the Magento_LayeredNavigation module. For

### Layouts

This module introduces the following layouts in the `view/frontend/layout` directory:
This module introduces the following layout handles in the `view/frontend/layout` directory:
- `catalog_category_view_type_layered`
- `catalog_category_view_type_layered_without_children`
- `catalogsearch_result_index`
Expand All @@ -41,6 +41,14 @@ For information about a public API in Magento 2, see [Public interfaces & APIs](

## Additional information

More information can get at articles:
### Page Layout
This module modifies the following page_layout in the `view/frontend.page_layout` directory:
- `1columns` - moves block `catalog.leftnav` into the `content.top` container
- `2columns-left` - moves block `catalog.leftnav` into the `sidebar.main"` container
- `2columns-right` - moves block `catalog.leftnav` into the `sidebar.main"` container
- `3columns` - moves block `catalog.leftnav` into the `sidebar.main"` container
- `empty` - moves block `catalog.leftnav` into the `category.product.list.additional` container

More information can be found in:
- [Learn more about Layered Navigation](https://docs.magento.com/user-guide/catalog/navigation-layered.html)
- [Learn how to Configuring Layered Navigation](https://docs.magento.com/user-guide/catalog/navigation-layered-configuration.html)

0 comments on commit 7f1dd3f

Please sign in to comment.