Skip to content

Commit 7f1dd3f

Browse files
committed
PR improvement
1 parent b01435e commit 7f1dd3f

File tree

5 files changed

+45
-45
lines changed

5 files changed

+45
-45
lines changed

app/code/Magento/ImportExport/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ The Magento_ImportExport module creates the following tables in the database:
99
- `importexport_importdata`
1010
- `import_history`
1111

12+
All database schema changes made by this module are rolled back when the module gets disabled and setup:upgrade command is run.
13+
1214
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).
1315

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

2628
### Layouts
2729

28-
This module introduces the following layouts in the `view/frontend/layout` directory:
30+
This module introduces the following layout handles in the `view/frontend/layout` directory:
2931

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

5153
- `Magento\ImportExport\Api\Data\ExportInfoInterface`
52-
- export data
54+
- getter and setter interface with data needed for export
55+
56+
- `Magento\ImportExport\Api\Data\ExtendedExportInfoInterface`
57+
- extends `Magento\ImportExport\Api\Data\ExportInfoInterface`. Contains data for skipped attributes
5358

54-
- `\Magento\ImportExport\Api\ExportManagementInterface`:
55-
- get export data
59+
- `\Magento\ImportExport\Api\ExportManagementInterface`
60+
- Executing actual export and returns export data
5661

5762
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).
5863

app/code/Magento/Indexer/README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Magento_Indexer module
22

33
This module provides Magento Indexing functionality.
4-
It allows:
4+
It allows to:
55
- read indexers configuration
66
- represent indexers in admin
77
- regenerate indexes by cron schedule
@@ -43,42 +43,28 @@ The module dispatches the following events:
4343
#### Model
4444

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

4848
#### Plugin
4949

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

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

5656
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).
5757

5858
### Layouts
5959

60-
This module introduces the following layouts in the `view/adminhtml/layout` directory:
60+
This module introduces the following layout handles in the `view/adminhtml/layout` directory:
6161
- `indexer_indexer_list`
6262
- `indexer_indexer_list_grid`
6363

6464
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).
6565

6666
## Additional information
6767

68-
### Magento indexers
69-
70-
List of Magento default indexers:
71-
- `design_config_grid` - Design Config Grid
72-
- `customer_grid` - Customer Grid
73-
- `catalog_category_product` - Category Products
74-
- `catalog_product_category` - Product Categories
75-
- `catalogrule_rule` - Catalog Rule Product
76-
- `catalog_product_attribute` - Product EAV
77-
- `catalogrule_product` - Catalog Product Rule
78-
- `cataloginventory_stock` - Stock
79-
- `catalog_product_price` - Product Price
80-
- `catalogsearch_fulltext` - Catalog Search
81-
8268
### Indexer modes
8369

8470
There are 2 modes of the Indexers:
@@ -91,11 +77,12 @@ There are 2 modes of the Indexers:
9177
Magento_Indexers provides console commands:
9278
- `bin/magento indexer:info` - view a list of all indexers
9379
- `bin/magento indexer:status [indexer]` - view index status
94-
- `bin/magento indexer:info` - view list all indexers
9580
- `bin/magento indexer:reindex [indexer]` - run reindex
9681
- `bin/magento indexer:reset [indexer]` - reset indexers
9782
- `bin/magento indexer:show-mode [indexer]` - view the current indexer configuration
9883
- `bin/magento indexer:set-mode {realtime|schedule} [indexer]` - specify the indexer configuration
84+
- `bin/magento indexer:set-dimensions-mode [indexer]` - set indexer dimension mode
85+
- `bin/magento indexer:show-dimensions-mode [indexer]` - set indexer dimension mode
9986

10087
### Cron options
10188

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

10996
More information can get at articles:
11097
- [Learn more about indexing](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexing.html)
111-
- [Learn more about Indexr optimization](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexer-batch.html)
98+
- [Learn more about Indexer optimization](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexer-batch.html)
11299
- [Learn more how to add custom indexer](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/indexing-custom.html)
113100
- [Learn how to manage indexers](https://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-index.html)
114101
- [Learn more about Index Management](https://docs.magento.com/user-guide/system/index-management.html)

app/code/Magento/InstantPurchase/README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,6 @@ Extension developers can interact with the Magento_InstantPurchase module. For m
1818

1919
[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.
2020

21-
### Layouts
22-
23-
This module introduces the following layouts in the `view/frontend/layout` directory:
24-
- `catalog_product_view`
25-
- `catalog_product_view_type_bundle`
26-
27-
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).
28-
2921
### Public APIs
3022

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

5850
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).
5951

52+
## Additional information
53+
6054
### Instant purchase customization
6155

6256
Almost all aspects of instant purchase may be customized. See comments to classes and interfaces marked with `@api` tag.
@@ -89,9 +83,7 @@ Basic implementation is a good start point but it's recommended to provide own i
8983
- `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.
9084
- `Magento\InstantPurchase\PaymentMethodIntegration\PaymentAdditionalInformationProviderInterface` - allows to add some extra values to payment additional information array. Default implementation returns empty array.
9185

92-
## Additional information
93-
94-
#Prerequisites to display the Instant Purchase button
86+
### Prerequisites to display the Instant Purchase button
9587

9688
1. Instant purchase enabled for a store at `Store / Configurations / Sales / Sales / Instant Purchase`
9789
2. Customer is logged in

app/code/Magento/Integration/README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,13 @@ model for request and access token management.
77

88
## Installation
99

10-
Before installing this module, note that the Magento_Integration is dependent on the following modules:
10+
The Magento_Integration module is one of the base Magento 2 modules. You cannot disable or uninstall this module.
11+
12+
This module is dependent on the following modules:
1113
- `Magento_Store`
1214
- `Magento_User`
1315
- `Magento_Security`
1416

15-
The following modules depend on this module:
16-
- `Magento_Analytics`
17-
- `Magento_Webapi`
18-
1917
The Magento_Integration module creates the following tables in the database:
2018
- `oauth_consumer`
2119
- `oauth_token`
@@ -37,13 +35,13 @@ The module dispatches the following events:
3735

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

4240
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).
4341

4442
### Layouts
4543

46-
This module introduces the following layouts in the `view/adminhtml/layout` directory:
44+
This module introduces the following layout handles in the `view/adminhtml/layout` directory:
4745
- `adminhtml_integration_edit`
4846
- `adminhtml_integration_grid`
4947
- `adminhtml_integration_grid_block`
@@ -79,6 +77,16 @@ For more information about a layout in Magento 2, see the [Layout documentation]
7977
- update an Integration
8078
- delete an Integration by integration ID
8179
- get an array of selected resources for an integration
80+
81+
- `\Magento\Integration\Api\OauthServiceInterface`:
82+
- create a new consumer account
83+
- create access token for provided consumer
84+
- retrieve access token assigned to the consumer
85+
- load consumer by its ID
86+
- load consumer by its key
87+
- execute post to integration (consumer) HTTP Post URL. Generate and return oauth_verifier
88+
- delete the consumer data associated with the integration including its token and nonce
89+
- remove token associated with provided consumer
8290

8391
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).
8492

app/code/Magento/LayeredNavigation/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Extension developers can interact with the Magento_LayeredNavigation module. For
1616

1717
### Layouts
1818

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

4242
## Additional information
4343

44-
More information can get at articles:
44+
### Page Layout
45+
This module modifies the following page_layout in the `view/frontend.page_layout` directory:
46+
- `1columns` - moves block `catalog.leftnav` into the `content.top` container
47+
- `2columns-left` - moves block `catalog.leftnav` into the `sidebar.main"` container
48+
- `2columns-right` - moves block `catalog.leftnav` into the `sidebar.main"` container
49+
- `3columns` - moves block `catalog.leftnav` into the `sidebar.main"` container
50+
- `empty` - moves block `catalog.leftnav` into the `category.product.list.additional` container
51+
52+
More information can be found in:
4553
- [Learn more about Layered Navigation](https://docs.magento.com/user-guide/catalog/navigation-layered.html)
4654
- [Learn how to Configuring Layered Navigation](https://docs.magento.com/user-guide/catalog/navigation-layered-configuration.html)

0 commit comments

Comments
 (0)