updated readme file for Ui, Ups, UrlRewrite, UrlRewriteGraphQl, User, and Usps #31483
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,81 @@ | ||
| # Magento_Ui module | ||
|
|
||
| The **Magento_Ui** module introduces a set of common UI components, which could be used and configured via layout XML files. | ||
|
|
||
| ## Installation details | ||
|
|
||
| The **Magento_Ui** module can be installed automatically (using the native Magento Setup)) without any additional actions. | ||
|
|
||
| Before installing this module, note that the **Magento_Ui** is dependent on the following modules: | ||
|
|
||
| - Magento_Authorization | ||
| - Magento_Backend | ||
| - Magento_Directory | ||
| - Magento_Eav | ||
| - Magento_Store | ||
| - Magento_User | ||
|
|
||
| Before disabling or uninstalling this module, please consider the following dependencies: | ||
|
There was a problem hiding this comment. You have seen my other reviews. "please consider" > "note" |
||
|
|
||
| - Magento_GoogleOptimizer | ||
| - Magento_MediaGalleryIntegration | ||
| - Magento_ReleaseNotification | ||
| - Magento_Shipping | ||
|
|
||
| Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). | ||
|
|
||
| ## Structure | ||
|
|
||
| - `Component/` - directory that contains several component implementations. | ||
| - `Config/` - directory that contains configuration files for Argument, Converter, and Reader. | ||
|
|
||
| For information about a typical file structure of a module in Magento 2, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure). | ||
|
|
||
| ### Layouts | ||
|
|
||
| This module introduces the following layouts and layout handles in the directories: | ||
|
|
||
| - `view/base/layout`: | ||
| - `default` | ||
|
|
||
| For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). | ||
|
There was a problem hiding this comment. As I have mentioned in other review, no need to mention "Magento 2" |
||
|
|
||
| ### UI components | ||
|
|
||
| You can extend a customer form and widgets using the configuration files located in the directories | ||
|
|
||
| - `view/base/ui_component`: | ||
| - `etc`: | ||
| - `definition.map` | ||
| - `definition` | ||
| - `templates`: | ||
| - `container`: | ||
| - `default` | ||
| - `export`: | ||
| - `button` | ||
| - `form`: | ||
| - `collapsible` | ||
| - `default` | ||
| - `listing`: | ||
| - `default` | ||
|
|
||
| For information about a UI component in Magento 2, see [Overview of UI components](https://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html). | ||
|
|
||
| ### Public APIs | ||
|
|
||
| `\Magento\Ui\Api\BookmarkManagementInterface`: | ||
|
|
||
| - Retrieve list of bookmarks by namespace. | ||
| - Retrieve bookmark by a identifier and namespace. | ||
|
|
||
| `\Magento\Ui\Api\BookmarkRepositoryInterface`: | ||
|
|
||
| - Save bookmark. | ||
| - Retrieve bookmark. | ||
| - Retrieve bookmarks matching the specified criteria. | ||
| - Delete bookmark. | ||
| - Delete bookmark by ID. | ||
|
|
||
| [Learn detailed description of the Magento_Sales API.](https://devdocs.magento.com/guides/v2.4/mrg/ce/Sales/services.html) | ||
|
|
||
| For information about a public API in Magento 2, see [Public interfaces & APIs](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,41 @@ | ||
| # Magento_Ups module | ||
|
|
||
| The **Magento_Ups** module implements integration with the United Parcel Service shipping carrier. | ||
|
|
||
| ## Installation details | ||
|
|
||
| Before installing this module, note that the **Magento_Ups** is dependent on the following modules: | ||
|
|
||
| - Magento_Backend | ||
| - Magento_CatalogInventory | ||
| - Magento_Directory | ||
| - Magento_Quote | ||
| - Magento_Sales | ||
| - Magento_Shipping | ||
| - Magento_Store | ||
| - Magento_User | ||
|
|
||
| Before disabling or uninstalling this module, please consider the following dependencies: | ||
|
|
||
| - Magento_TestModuleUps | ||
|
|
||
| Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). | ||
|
|
||
| ## Extensibility | ||
|
|
||
| Extension developers can interact with the Magento_Ups module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). | ||
|
|
||
| [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_Ups module. | ||
|
|
||
| ### Layouts | ||
|
|
||
| This module introduces the following layouts and layout handles in the directories: | ||
|
|
||
| - `view/adminhtml/layout`: | ||
| - `adminhtml_system_config_edit` | ||
|
|
||
| - `view/frantend/layout`: | ||
| - `checkout_cart_index` | ||
| - `checkout_index_index` | ||
|
|
||
| For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,55 @@ | ||
| # Magento_UrlRewrite module | ||
|
|
||
| The **Magento_UrlRewrite** module provides ability to customize website URLs by creating custom URL rewrite rules. | ||
|
|
||
| ## Installation details | ||
|
|
||
| Before installing this module, note that the **Magento_Ups** is dependent on the following modules: | ||
|
|
||
| - Magento_Backend | ||
| - Magento_Catalog | ||
| - Magento_CatalogUrlRewrite | ||
| - Magento_Cms | ||
| - Magento_CmsUrlRewrite | ||
| - Magento_Store | ||
| - Magento_Ui | ||
|
|
||
| Before disabling or uninstalling this module, please consider the following dependencies: | ||
|
|
||
| - Magento_SampleData | ||
|
|
||
| Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). | ||
|
|
||
| ## Structure | ||
|
|
||
| - `Service/` - directory that contains Data abstract class for url storage. | ||
| - `Setup/` - directory that contains `ConvertSerializedDataToJson` class which converts serialized data to Json. | ||
|
|
||
| For information about a typical file structure of a module in Magento 2, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure). | ||
|
|
||
| ### Events | ||
|
|
||
| The module dispatches the following events: | ||
|
|
||
| - `clean_cache_by_tags` event in the `\Magento\UrlRewrite\Model\UrlRewrite::cleanCacheForEntity()` method. Parameters: | ||
| - `object` is a cacheContext object (`\Magento\Framework\Indexer\CacheContext` class). | ||
|
|
||
| For information about the event system 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 and layout handles in the directories: | ||
|
|
||
| - `view/adminhtml/layout`: | ||
| - `adminhtml_url_rewrite_index` | ||
|
|
||
| For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). | ||
|
|
||
| ### UI components | ||
|
|
||
| You can extend a customer form and widgets using the configuration files located in the directories | ||
|
|
||
| - `view/adminhtml/ui_component`: | ||
| - `url_rewrite_listing` | ||
|
|
||
| For information about a UI component in Magento 2, see [Overview of UI components](https://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,25 @@ | ||
| # Magento_UrlRewriteGraphQl module | ||
|
|
||
| The **Magento_UrlRewriteGraphQl** module provides type information for the GraphQl module to generate url rewrites from entities that implement such rewrites, like categories, products or cms and other 3rd party modules. | ||
|
|
||
| The **Magento_UrlRewriteGraphQl** module extends **Magento_GraphQl** and **Magento_UrlRewrite** modules. This module provides type and resolver information for GraphQL API. | ||
|
|
||
| ## Installation details | ||
|
|
||
| Before installing this module, note that the **Magento_UrlRewriteGraphQl** is dependent on the following modules: | ||
|
|
||
| - Magento_UrlRewrite | ||
|
|
||
| Before disabling or uninstalling this module, please consider the following dependencies: | ||
|
|
||
| - Magento_CatalogUrlRewriteGraphQl | ||
|
|
||
| Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). | ||
|
There was a problem hiding this comment. Remove all the instances of "Please" |
||
|
|
||
| ## Additional information | ||
|
|
||
| For more information about the **Magento_UrlRewriteGraphQl** [Queries](#queries) see below: | ||
|
|
||
| ### Queries {#queries} | ||
|
|
||
| - [`urlResolver`](https://devdocs.magento.com/guides/v2.4/graphql/queries/url-resolver.html) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,62 @@ | ||
| # Magento_User module | ||
|
|
||
| The **Magento_User** module enables admin users to manage and assign roles to administrators and other non-customer users, reset user passwords, and invalidate access tokens. | ||
|
|
||
| Different roles can be assigned to different users to define their permissions. | ||
|
|
||
| For admin passwords, it enables setting lifetimes and locking them when expired or when a specified number of failures have occurred. It allows preventing password brute force attacks for system backend. | ||
|
|
||
| ## Installation details | ||
|
|
||
| Before installing this module, note that the **Magento_User** is dependent on the following modules: | ||
|
|
||
| - Magento_Authorization | ||
| - Magento_Backend | ||
| - Magento_Config | ||
| - Magento_Email | ||
| - Magento_Integration | ||
| - Magento_Security | ||
| - Magento_Store | ||
| - Magento_Ui | ||
|
|
||
| Before disabling or uninstalling this module, please consider the following dependencies: | ||
|
|
||
| - Magento_AsynchronousOperations | ||
| - Magento_EncryptionKey | ||
| - Magento_Integration | ||
| - Magento_ReleaseNotification | ||
| - Magento_Shipping | ||
| - Magento_Tax | ||
|
|
||
| Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). | ||
|
|
||
| ## Structure | ||
|
|
||
| - `Observer/` - directory that contains model for Authentication, ForceAdminPasswordChange, and TrackAdminNewPassword observer. | ||
| - `Setup/` - directory that contains patch data file to upgrade password hashes and serialized fields. | ||
|
|
||
| For information about a typical file structure of a module in Magento 2, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure). | ||
|
|
||
| ### Layouts | ||
|
|
||
| This module introduces the following layouts and layout handles in the directories: | ||
|
|
||
| - `view/adminhtml/layout`: | ||
| - `adminhtml_auth_forgotpassword` | ||
| - `adminhtml_auth_login` | ||
| - `adminhtml_auth_resetpassword` | ||
| - `adminhtml_locks_block` | ||
| - `adminhtml_locks_grid` | ||
| - `adminhtml_locks_index` | ||
| - `adminhtml_user_edit` | ||
| - `adminhtml_user_grid_block` | ||
| - `adminhtml_user_index` | ||
| - `adminhtml_user_role_editrole` | ||
| - `adminhtml_user_role_editrolegrid` | ||
| - `adminhtml_user_role_grid_block` | ||
| - `adminhtml_user_role_index` | ||
| - `adminhtml_user_role_rolegrid` | ||
| - `adminhtml_user_rolegrid` | ||
| - `adminhtml_user_rolesgrid` | ||
|
|
||
| For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,28 @@ | ||
| # Magento_Usps module | ||
|
|
||
| The **Magento_Usps** module provides integration with the United States Postal Service shipping carrier. | ||
|
|
||
| ## Installation details | ||
|
|
||
| Before installing this module, note that the **Magento_Usps** is dependent on the following modules: | ||
|
|
||
| - Magento_Catalog | ||
| - Magento_CatalogInventory | ||
| - Magento_Config | ||
| - Magento_Directory | ||
| - Magento_Quote | ||
| - Magento_Sales | ||
| - Magento_Shipping | ||
| - Magento_Store | ||
|
|
||
| Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). | ||
|
|
||
| ### Layouts | ||
|
|
||
| This module introduces the following layouts and layout handles in the directories: | ||
|
|
||
| - `view/frantend/layout`: | ||
| - `checkout_cart_index` | ||
| - `checkout_index_index` | ||
|
|
||
| For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And again, no need to bold the module names anywhere. Please remove them.