Skip to content

Commit 6ae6cc5

Browse files
vlmedvlmed
committed
[ReadMe] updated readMe file for Fedex-GoogleOptimizer modules
1 parent 3b860f5 commit 6ae6cc5

File tree

6 files changed

+255
-10
lines changed

6 files changed

+255
-10
lines changed

‎app/code/Magento/Fedex/README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,28 @@
1-
The Magento_Fedex implements the integration with the FedEx shipping carrier.
1+
# Magento_Fedex module
2+
3+
This module implements the integration with the FedEx shipping carrier.
4+
5+
## Installation details
6+
7+
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).
8+
9+
## Extensibility
10+
11+
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).
12+
13+
[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.
14+
15+
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.
16+
17+
### Layouts
18+
19+
This module introduces the following layouts in the `view/frontend/layout` directory:
20+
- `checkout_cart_index`
21+
- `checkout_index_index`
22+
23+
## Additional information
24+
25+
You can get more information about delivery method in magento at the articles:
26+
- [FedEx Configuration Settings](https://docs.magento.com/user-guide/shipping/fedex.html)
27+
- [Delivery Methods Configuration](https://docs.magento.com/user-guide/configuration/sales/delivery-methods.html)
28+
- [Add custom shipping carrier](https://devdocs.magento.com/guides/v2.4/howdoi/checkout/checkout-add-custom-carrier.html)

‎app/code/Magento/GiftMessage/README.md

Lines changed: 104 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,104 @@
1-
Magento\GiftMessage module allows to add a message to order or to each ordered item either on frontend or backend.
1+
# Magento_GiftMessage module
2+
3+
This module allows to add a message to order or to each ordered item either on frontend or backend.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_GiftMessage is dependent on the following modules:
8+
9+
- `Magento_Catalog`
10+
- `Magento_Sales`
11+
- `Magento_Quote`
12+
13+
Before disabling or uninstalling this module, note that the Magento_GiftMessageGraphQl module depends on this module
14+
15+
The Magento_GiftMessage module creates the `gift_message` table in the database.
16+
17+
This module modifies the following tables in the database:
18+
19+
- `quote` - adds column `gift_message_id`
20+
- `quote_address` - adds column `gift_message_id`
21+
- `quote_item` - adds column `gift_message_id`
22+
- `quote_address_item` - adds column `gift_message_id`
23+
- `sales_order` - adds column `gift_message_id`
24+
- `sales_order_item` - adds columns `gift_message_id` and `gift_message_available`
25+
26+
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).
27+
28+
## Extensibility
29+
30+
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).
31+
32+
[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.
33+
34+
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.
35+
36+
### Events
37+
38+
The module dispatches the following events:
39+
- `gift_options_prepare_items` event in the `\Magento\GiftMessage\Block\Message\Inline::getItems` method. Parameters:
40+
- `items` is a entityItems (`array` type)
41+
42+
- `gift_options_prepare` event in the `\Magento\GiftMessage\Block\Message\Inline::isMessagesOrderAvailable` method. Parameters:
43+
- `entity` is an entity object
44+
45+
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).
46+
47+
### Layout
48+
49+
This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories:
50+
- `view/adminhtml/layout`:
51+
- `sales_order_create_index`
52+
- `sales_order_create_load_block_data`
53+
- `sales_order_create_load_block_items`
54+
- `sales_order_view`
55+
- `view/frontend/layout`:
56+
- `checkout_cart_index`
57+
- `checkout_cart_item_renderers`
58+
59+
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).
60+
61+
### Public APIs
62+
63+
#### Data
64+
65+
- `Magento\GiftMessage\Api\Data\MessageInterface`
66+
- gift message data
67+
68+
#### Cart
69+
70+
- `\Magento\GiftMessage\Api\CartRepositoryInterface`
71+
- get the gift message by cart ID for specified shopping cart
72+
- set the gift message for an entire shopping cart
73+
74+
- `\Magento\GiftMessage\Api\GuestCartRepositoryInterface`
75+
- get the gift message by cart ID for specified shopping cart
76+
- set the gift message for an entire shopping cart
77+
78+
#### Cart Item
79+
80+
- `\Magento\GiftMessage\Api\GuestItemRepositoryInterface`
81+
- get the gift message for a specified item in a specified shopping cart
82+
- set the gift message for a specified item in a specified shopping cart
83+
84+
- `\Magento\GiftMessage\Api\ItemRepositoryInterface`
85+
- get the gift message for a specified item in a specified shopping cart
86+
- set the gift message for a specified item in a specified shopping cart
87+
88+
#### Order
89+
90+
- `\Magento\GiftMessage\Api\OrderItemRepositoryInterface`
91+
- get the gift message for a specified order
92+
- set the gift message for an entire order
93+
94+
#### Order Item
95+
96+
- `\Magento\GiftMessage\Api\OrderItemRepositoryInterface`
97+
- get the gift message for a specified item in a specified order
98+
- set the gift message for a specified item in a specified order
99+
100+
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).
101+
102+
## Additional information
103+
104+
[Learn more about Gift Options and Gift Message](https://docs.magento.com/user-guide/sales/gift-options.html).

‎app/code/Magento/GiftMessageGraphQl/README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1-
# GiftMessageGraphQl
1+
# Magento_GiftMessageGraphQl module
22

3-
**GiftMessageGraphQl** provides information about gift messages for carts, cart items, orders and order items.
3+
This module provides information about gift messages for carts, cart items, orders and order items.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_GiftMessageGraphQl is dependent on the Magento_GiftMessage module.
8+
9+
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).
10+
11+
## Extensibility
12+
13+
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).
14+
15+
[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.
16+
17+
## Additional information
18+
19+
You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql).

‎app/code/Magento/GoogleAdwords/README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
1-
GoogleAdwords is a module designed for integration of Google Adwords service.
1+
# Magento_GoogleAdwords module
2+
3+
This module implements the integration with the Google AdWords service.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_GoogleAdwords is dependent on the Magento_Checkout module.
8+
9+
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).
10+
11+
## Extensibility
12+
13+
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).
14+
15+
[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.
16+
17+
### Layouts
18+
19+
This module introduces the following layouts in the `view/frontend/layout` directory:
20+
- `checkout_onepage_success`
21+
22+
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).
23+
24+
## Additional information
25+
26+
[Learn how to configure Google AdWords](https://docs.magento.com/user-guide/marketing/google-adwords.html).

‎app/code/Magento/GoogleAnalytics/README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,30 @@
1-
Magento_GoogleAnalytics is a module for integration with Google Analytics service.
1+
# Magento_GoogleAnalytics module
2+
3+
This module implements the integration with the Google Analytics service.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_GoogleAnalytics is dependent on the Magento_Store module.
8+
9+
Before disabling or uninstalling this module, note that the Magento_GoogleOptimizer module depends on this module
10+
11+
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).
12+
13+
## Extensibility
14+
15+
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).
16+
17+
[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.
18+
19+
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.
20+
21+
### Layouts
22+
23+
This module introduces the following layouts in the `view/frontend/layout` directory:
24+
- `default`
25+
26+
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).
27+
28+
## Additional information
29+
30+
[Learn how to configure Google Analytics](https://docs.magento.com/user-guide/marketing/google-universal-analytics.html).

‎app/code/Magento/GoogleOptimizer/README.md

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,53 @@
1-
Magento_GoogleOptimizer module implements functionality of Google Experiment tool that is the part of Google Analytics functionality.
1+
# Magento_GoogleOptimizer module
22

3-
Google Experiment (on Google side) allows to make two variants of the same page and compare their popularity.
3+
This module implements functionality of Google Experiment tool that is the part of Google Analytics functionality.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_GoogleOptimizer is dependent on the following modules:
8+
9+
- `Magento_GoogleAnalytics`
10+
- `Magento_Catalog`
11+
- `Magento_Cms`
12+
- `Magento_Ui`
13+
14+
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).
15+
16+
## Extensibility
17+
18+
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).
19+
20+
[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.
21+
22+
### Layouts
23+
24+
This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories:
25+
- `view/adminhtml/layout`:
26+
- `catalog_product_new`
27+
- `cms_page_edit`
28+
- `view/frontend/layout`:
29+
- `catalog_category_view`
30+
- `catalog_product_view`
31+
- `cms_page_view`
32+
33+
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).
34+
35+
### UI components
36+
37+
This module extends following ui components located in the `view/adminhtml/ui_component` directory:
38+
- `category_form`
39+
- `cms_page_form`
40+
- `new_category_form`
41+
42+
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).
43+
44+
## Additional information
45+
46+
Google Experiment (on Google side) allows to make two variants of the same page and compare their popularity.
447
From Magento side, code generated by Google should be saved and displayed on a particular page.
5-
Google Experiment functionality is available on pages of products, categories and cms pages.
48+
Google Experiment functionality is available on pages of products, categories and cms pages.
649
This allows to save different codes for products and categories on different store views.
7-
This functionality can be switched on and off on the configuration page (Stores -> Configuration -> General -> Google Api -> Google Analytics).
50+
This functionality can be switched on and off on the configuration page (`Stores -> Configuration -> General -> Google Api -> Google Analytics`).
851
Also this functionality depends on Google Analytics module and configuration options.
52+
53+
[Learn how to configure Google Content Experiments](https://docs.magento.com/user-guide/marketing/google-content-experiments.html).

0 commit comments

Comments
 (0)