-
Notifications
You must be signed in to change notification settings - Fork 9.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ENGCOM-9257: [ReadMe] updated readMe file for Fedex-GoogleOptimizer m…
…odules #31785
- Loading branch information
Showing
6 changed files
with
256 additions
and
10 deletions.
There are no files selected for viewing
This file contains 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 @@ | ||
| The Magento_Fedex implements the integration with the FedEx shipping carrier. | ||
| # Magento_Fedex module | ||
|
|
||
| This module implements the integration with the FedEx shipping carrier. | ||
|
|
||
| ## Installation details | ||
|
|
||
| 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). | ||
|
|
||
| ## Extensibility | ||
|
|
||
| Extension developers can interact with the Magento_Fedex module. For more information about the Magento extension mechanism, see [Magento plugins](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_Fedex module. | ||
|
|
||
| A lot of functionality in the module is on JavaScript, use [mixins](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/js_mixins.html) to extend it. | ||
|
|
||
| ### Layouts | ||
|
|
||
| This module introduces the following layouts in the `view/frontend/layout` directory: | ||
| - `checkout_cart_index` | ||
| - `checkout_index_index` | ||
|
|
||
| ## Additional information | ||
|
|
||
| You can get more information about delivery method in magento at the articles: | ||
| - [FedEx Configuration Settings](https://docs.magento.com/user-guide/shipping/fedex.html) | ||
| - [Delivery Methods Configuration](https://docs.magento.com/user-guide/configuration/sales/delivery-methods.html) | ||
| - [Add custom shipping carrier](https://devdocs.magento.com/guides/v2.4/howdoi/checkout/checkout-add-custom-carrier.html) |
This file contains 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,104 @@ | ||
| Magento\GiftMessage module allows to add a message to order or to each ordered item either on frontend or backend. | ||
| # Magento_GiftMessage module | ||
|
|
||
| This module allows to add a message to order or to each ordered item either on frontend or backend. | ||
|
|
||
| ## Installation | ||
|
|
||
| Before installing this module, note that the Magento_GiftMessage is dependent on the following modules: | ||
|
|
||
| - `Magento_Catalog` | ||
| - `Magento_Sales` | ||
| - `Magento_Quote` | ||
|
|
||
| Before disabling or uninstalling this module, note that the Magento_GiftMessageGraphQl module depends on this module | ||
|
|
||
| The Magento_GiftMessage module creates the `gift_message` table in the database. | ||
|
|
||
| This module modifies the following tables in the database: | ||
|
|
||
| - `quote` - adds column `gift_message_id` | ||
| - `quote_address` - adds column `gift_message_id` | ||
| - `quote_item` - adds column `gift_message_id` | ||
| - `quote_address_item` - adds column `gift_message_id` | ||
| - `sales_order` - adds column `gift_message_id` | ||
| - `sales_order_item` - adds columns `gift_message_id` and `gift_message_available` | ||
|
|
||
| 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). | ||
|
|
||
| ## Extensibility | ||
|
|
||
| Extension developers can interact with the Magento_GiftMessage module. For more information about the Magento extension mechanism, see [Magento plugins](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_GiftMessage module. | ||
|
|
||
| A lot of functionality in the module is on JavaScript, use [mixins](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/js_mixins.html) to extend it. | ||
|
|
||
| ### Events | ||
|
|
||
| The module dispatches the following events: | ||
| - `gift_options_prepare_items` event in the `\Magento\GiftMessage\Block\Message\Inline::getItems` method. Parameters: | ||
| - `items` is a entityItems (`array` type) | ||
|
|
||
| - `gift_options_prepare` event in the `\Magento\GiftMessage\Block\Message\Inline::isMessagesOrderAvailable` method. Parameters: | ||
| - `entity` is an entity object | ||
|
|
||
| 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). | ||
|
|
||
| ### Layout | ||
|
|
||
| This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories: | ||
| - `view/adminhtml/layout`: | ||
| - `sales_order_create_index` | ||
| - `sales_order_create_load_block_data` | ||
| - `sales_order_create_load_block_items` | ||
| - `sales_order_view` | ||
| - `view/frontend/layout`: | ||
| - `checkout_cart_index` | ||
| - `checkout_cart_item_renderers` | ||
|
|
||
| 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). | ||
|
|
||
| ### Public APIs | ||
|
|
||
| #### Data | ||
|
|
||
| - `Magento\GiftMessage\Api\Data\MessageInterface` | ||
| - gift message data | ||
|
|
||
| #### Cart | ||
|
|
||
| - `\Magento\GiftMessage\Api\CartRepositoryInterface` | ||
| - get the gift message by cart ID for specified shopping cart | ||
| - set the gift message for an entire shopping cart | ||
|
|
||
| - `\Magento\GiftMessage\Api\GuestCartRepositoryInterface` | ||
| - get the gift message by cart ID for specified shopping cart | ||
| - set the gift message for an entire shopping cart | ||
|
|
||
| #### Cart Item | ||
|
|
||
| - `\Magento\GiftMessage\Api\GuestItemRepositoryInterface` | ||
| - get the gift message for a specified item in a specified shopping cart | ||
| - set the gift message for a specified item in a specified shopping cart | ||
|
|
||
| - `\Magento\GiftMessage\Api\ItemRepositoryInterface` | ||
| - get the gift message for a specified item in a specified shopping cart | ||
| - set the gift message for a specified item in a specified shopping cart | ||
|
|
||
| #### Order | ||
|
|
||
| - `\Magento\GiftMessage\Api\OrderItemRepositoryInterface` | ||
| - get the gift message for a specified order | ||
| - set the gift message for an entire order | ||
|
|
||
| #### Order Item | ||
|
|
||
| - `\Magento\GiftMessage\Api\OrderItemRepositoryInterface` | ||
| - get the gift message for a specified item in a specified order | ||
| - set the gift message for a specified item in a specified order | ||
|
|
||
| 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 | ||
|
|
||
| [Learn more about Gift Options and Gift Message](https://docs.magento.com/user-guide/sales/gift-options.html). |
This file contains 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,3 +1,19 @@ | ||
| # GiftMessageGraphQl | ||
| # Magento_GiftMessageGraphQl module | ||
|
|
||
| **GiftMessageGraphQl** provides information about gift messages for carts, cart items, orders and order items. | ||
| This module provides information about gift messages for carts, cart items, orders and order items. | ||
|
|
||
| ## Installation | ||
|
|
||
| Before installing this module, note that the Magento_GiftMessageGraphQl is dependent on the Magento_GiftMessage module. | ||
|
|
||
| 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). | ||
|
|
||
| ## Extensibility | ||
|
|
||
| Extension developers can interact with the Magento_GiftMessageGraphQl module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). | ||
|
|
||
| [The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_GiftMessageGraphQl module. | ||
|
|
||
| ## Additional information | ||
|
|
||
| You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). |
This file contains 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,26 @@ | ||
| GoogleAdwords is a module designed for integration of Google Adwords service. | ||
| # Magento_GoogleAdwords module | ||
|
|
||
| This module implements the integration with the Google AdWords service. | ||
|
|
||
| ## Installation | ||
|
|
||
| Before installing this module, note that the Magento_GoogleAdwords is dependent on the Magento_Checkout module. | ||
|
|
||
| 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). | ||
|
|
||
| ## Extensibility | ||
|
|
||
| Extension developers can interact with the Magento_GoogleAdwords module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). | ||
|
|
||
| [The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_GoogleAdwords module. | ||
|
|
||
| ### Layouts | ||
|
|
||
| This module introduces the following layouts in the `view/frontend/layout` directory: | ||
| - `checkout_onepage_success` | ||
|
|
||
| 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). | ||
|
|
||
| ## Additional information | ||
|
|
||
| [Learn how to configure Google AdWords](https://docs.magento.com/user-guide/marketing/google-adwords.html). |
This file contains 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,30 @@ | ||
| Magento_GoogleAnalytics is a module for integration with Google Analytics service. | ||
| # Magento_GoogleAnalytics module | ||
|
|
||
| This module implements the integration with the Google Analytics service. | ||
|
|
||
| ## Installation | ||
|
|
||
| Before installing this module, note that the Magento_GoogleAnalytics is dependent on the Magento_Store module. | ||
|
|
||
| Before disabling or uninstalling this module, note that the Magento_GoogleOptimizer module depends on this module | ||
|
|
||
| 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). | ||
|
|
||
| ## Extensibility | ||
|
|
||
| Extension developers can interact with the Magento_GoogleAnalytics module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). | ||
|
|
||
| [The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_GoogleAnalytics module. | ||
|
|
||
| A lot of functionality in the module is on JavaScript, use [mixins](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/js_mixins.html) to extend it. | ||
|
|
||
| ### Layouts | ||
|
|
||
| This module introduces the following layouts in the `view/frontend/layout` directory: | ||
| - `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). | ||
|
|
||
| ## Additional information | ||
|
|
||
| [Learn how to configure Google Analytics](https://docs.magento.com/user-guide/marketing/google-universal-analytics.html). |
This file contains 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,8 +1,54 @@ | ||
| Magento_GoogleOptimizer module implements functionality of Google Experiment tool that is the part of Google Analytics functionality. | ||
| # Magento_GoogleOptimizer module | ||
|
|
||
| Google Experiment (on Google side) allows to make two variants of the same page and compare their popularity. | ||
| This module implements functionality of Google Experiment tool that is the part of Google Analytics functionality. | ||
|
|
||
| ## Installation | ||
|
|
||
| Before installing this module, note that the Magento_GoogleOptimizer is dependent on the following modules: | ||
|
|
||
| - `Magento_GoogleAnalytics` | ||
| - `Magento_Catalog` | ||
| - `Magento_Cms` | ||
| - `Magento_Ui` | ||
|
|
||
| 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). | ||
|
|
||
| ## Extensibility | ||
|
|
||
| Extension developers can interact with the Magento_GoogleOptimizer module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html). | ||
|
|
||
| [The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_GoogleOptimizer module. | ||
|
|
||
| ### Layouts | ||
|
|
||
| This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories: | ||
| - `view/adminhtml/layout`: | ||
| - `catalog_product_new` | ||
| - `cms_page_edit` | ||
| - `view/frontend/layout`: | ||
| - `catalog_category_view` | ||
| - `catalog_product_view` | ||
| - `cms_page_view` | ||
|
|
||
| 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 | ||
|
|
||
| This module extends following ui components located in the `view/adminhtml/ui_component` directory: | ||
| - `category_form` | ||
| - `cms_page_form` | ||
| - `new_category_form` | ||
|
|
||
| For information about a UI component in Magento 2, see [Overview of UI components](http://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html). | ||
|
|
||
| ## Additional information | ||
|
|
||
| Google Experiment (on Google side) allows to make two variants of the same page and compare their popularity. | ||
| From Magento side, code generated by Google should be saved and displayed on a particular page. | ||
| Google Experiment functionality is available on pages of products, categories and cms pages. | ||
| Google Experiment functionality is available on pages of products, categories and cms pages. | ||
| This allows to save different codes for products and categories on different store views. | ||
| This functionality can be switched on and off on the configuration page (Stores -> Configuration -> Sales -> Google Api -> Google Analytics). | ||
|
|
||
| This functionality can be switched on and off on the configuration page (`Stores -> Configuration -> General -> Google Api -> Google Analytics`). | ||
| Also this functionality depends on Google Analytics module and configuration options. | ||
|
|
||
| [Learn how to configure Google Content Experiments](https://docs.magento.com/user-guide/marketing/google-content-experiments.html). |