Skip to content

Commit fad5e61

Browse files
vlmedvlmed
committed
[ReadMe] updated readMe file for NewRelicReporting-OfflineShipping modules
1 parent 2a4641b commit fad5e61

File tree

5 files changed

+238
-14
lines changed

5 files changed

+238
-14
lines changed

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

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,46 @@
1-
Module Magento\NewRelicReporting implements integration New Relic APM and New Relic Insights with Magento, giving
2-
real-time visibility into business and performance metrics for data-driven decision making.
1+
# Magento_NewRelicReporting module
2+
3+
This module implements integration New Relic APM and New Relic Insights with Magento, giving real-time visibility into business and performance metrics for data-driven decision making.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_NewRelicReporting is dependent on the following modules:
8+
- `Magento_Store`
9+
- `Magento_Customer`
10+
- `Magento_Backend`
11+
- `Magento_Catalog`
12+
- `Magento_ConfigurableProduct`
13+
- `Magento_Config`
14+
15+
This module creates the following tables in the database:
16+
- `reporting_counts`
17+
- `reporting_module_status`
18+
- `reporting_orders`
19+
- `reporting_users`
20+
- `reporting_system_updates`
21+
22+
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).
23+
24+
## Extensibility
25+
26+
Extension developers can interact with the Magento_NewRelicReporting 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).
27+
28+
[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_NewRelicReporting module.
29+
30+
## Additional information
31+
32+
[Learn more about New Relic Reporting](https://docs.magento.com/user-guide/reports/new-relic-reporting.html).
33+
34+
### Console commands
35+
36+
The Magento_NewRelicReporting provides console commands:
37+
- `bin/magento newrelic:create:deploy-marker <message> <change_log> [<user>]` - check the deploy queue for entries and create an appropriate deploy marker
38+
39+
[Learn more about command's parameters](https://devdocs.magento.com/guides/v2.4/reference/cli/magento.html#newreliccreatedeploy-marker).
40+
41+
### Cron options
42+
43+
Cron group configuration can be set at `etc/crontab.xml`:
44+
- `magento_newrelicreporting_cron` - runs collecting all new relic reports
45+
46+
[Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html).

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

Lines changed: 82 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,82 @@
1-
Magento_Newsletter module allows clients to subscribe for information about new promotions and discounts and allows store administrators to send newsletters to clients subscribed for them.
1+
# Magento_Newsletter module
2+
3+
This module allows clients to subscribe for information about new promotions and discounts and allows store administrators to send newsletters to clients subscribed for them.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_Newsletter is dependent on the following modules:
8+
- `Magento_Store`
9+
- `Magento_Customer`
10+
- `Magento_Eav`
11+
- `Magento_Widget`
12+
13+
Before disabling or uninstalling this module, note that the following modules depends on this module:
14+
- `Magento_NewsletterGraphQl`
15+
16+
This module creates the following tables in the database:
17+
- `newsletter_subscriber`
18+
- `newsletter_template`
19+
- `newsletter_queue`
20+
- `newsletter_queue_link`
21+
- `newsletter_queue_store_link`
22+
- `newsletter_problem`
23+
24+
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).
25+
26+
## Extensibility
27+
28+
Extension developers can interact with the Magento_Newsletter 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).
29+
30+
[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_Newsletter module.
31+
32+
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.
33+
34+
### Layouts
35+
36+
This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories:
37+
- `view/adminhtml/layout`:
38+
- `newsletter_problem_block`
39+
- `newsletter_problem_grid`
40+
- `newsletter_problem_index`
41+
- `newsletter_queue_edit`
42+
- `newsletter_queue_grid`
43+
- `newsletter_queue_grid_block`
44+
- `newsletter_queue_index`
45+
- `newsletter_queue_preview`
46+
- `newsletter_queue_preview_popup`
47+
- `newsletter_subscriber_block`
48+
- `newsletter_subscriber_exportcsv`
49+
- `newsletter_subscriber_exportxml`
50+
- `newsletter_subscriber_grid`
51+
- `newsletter_subscriber_index`
52+
- `newsletter_template_edit`
53+
- `newsletter_template_preview`
54+
- `newsletter_template_preview_popup`
55+
- `preview`
56+
57+
- `view/frontend/layout`:
58+
- `customer_account`
59+
- `customer_account_create`
60+
- `newsletter_manage_index`
61+
- `default`
62+
63+
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).
64+
65+
### UI components
66+
67+
This module extends customer form ui component the configuration file located in the `view/base/ui_component` directory:
68+
- `customer_form`
69+
70+
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).
71+
72+
## Additional information
73+
74+
[Learn more about newsletter](https://docs.magento.com/user-guide/marketing/newsletters.html).
75+
76+
### Cron options
77+
78+
Cron group configuration can be set at `etc/crontab.xml`:
79+
- `newsletter_send_all` - schedules newsletter sending
80+
81+
[Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html).
82+

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

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
1-
The Magento_NewsletterGraphQl module allows a shopper to subscribe to a newsletter using GraphQL.
1+
# Magento_NewsletterGraphQl module
2+
3+
This module allows a shopper to subscribe to a newsletter using GraphQL.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_NewsletterGraphQl is dependent on the Magento_Newsletter 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_NewsletterGraphQl 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).
14+
15+
[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_NewsletterGraphQl module.

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

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
1-
The Magento_OfflinePayments module implements the payment methods which do not require interaction with a payment gateway (so called offline methods). These methods are the following:
2-
*Bank transfer
3-
*Cash on delivery
4-
*Check / Money Order
5-
*Purchase order
1+
# Magento_OfflinePayments module
2+
3+
This module implements the payment methods which do not require interaction with a payment gateway (so called offline methods).
4+
These methods are the following:
5+
- Bank transfer
6+
- Cash on delivery
7+
- Check / Money Order
8+
- Purchase order
9+
10+
## Installation
11+
12+
Before installing this module, note that the Magento_OfflinePayments is dependent on the following modules:
13+
- `Magento_Store`
14+
- `Magento_Catalog`
15+
16+
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).
17+
18+
## Extensibility
19+
20+
Extension developers can interact with the Magento_OfflinePayments 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).
21+
22+
[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_OfflinePayments module.
23+
24+
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.
25+
26+
### Layouts
27+
28+
This module introduces the following layouts in the `view/frontend/layout` directory:
29+
- `checkout_index_index`
30+
- `multishipping_checkout_billing`
31+
32+
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).
33+
34+
## Additional information
35+
36+
[Learn how to configure Offline Payment Methods](https://docs.magento.com/user-guide/payment/offline-payment-methods.html).

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

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,60 @@
1-
The Magento_OfflineShipping module implements the shipping methods which do not involve a direct interaction with shipping carriers, so called offline shipping methods. Namely, the following:
2-
*Free Shipping
3-
*Flat Rate
4-
*Table Rates
5-
*Store Pickup
1+
# Magento_OfflineShipping module
62

3+
This module implements the shipping methods which do not involve a direct interaction with shipping carriers, so called offline shipping methods.
4+
Namely, the following:
5+
- Free Shipping
6+
- Flat Rate
7+
- Table Rates
8+
- Store Pickup
9+
10+
## Installation
11+
12+
Before installing this module, note that the Magento_OfflineShipping is dependent on the following modules:
13+
- `Magento_Store`
14+
- `Magento_Sales`
15+
- `Magento_Quote`
16+
- `Magento_Quote`
17+
- `Magento_SalesRule`
18+
19+
The Magento_OfflineShipping module creates the `shipping_tablerate` table in the database.
20+
21+
This module modifies the following tables in the database:
22+
- `salesrule` - adds column `simple_free_shipping`
23+
- `sales_order_item` - adds column `free_shipping`
24+
- `quote_address` - adds column `free_shipping`
25+
- `quote_item` - adds column `free_shipping`
26+
- `quote_address_item` - adds column `free_shipping`
27+
28+
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).
29+
30+
## Extensibility
31+
32+
Extension developers can interact with the Magento_OfflineShipping 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).
33+
34+
[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_OfflineShipping module.
35+
36+
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.
37+
38+
### Layouts
39+
40+
This module introduces the following layouts in the `view/frontend/layout` directory:
41+
- `checkout_cart_index`
42+
- `checkout_index_index`
43+
44+
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).
45+
46+
### UI components
47+
48+
This module extends following ui components located in the `view/adminhtml/ui_component` directory:
49+
- `sales_rule_form`
50+
- `salesrulestaging_update_form`
51+
52+
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).
53+
54+
## Additional information
55+
56+
You can get more information about offline shipping methods in magento at the articles:
57+
- [How to configure Free Shipping](https://docs.magento.com/user-guide/shipping/shipping-free.html)
58+
- [How to configure Flat Rate](https://docs.magento.com/user-guide/shipping/shipping-flat-rate.html)
59+
- [How to configure Table Rates](https://docs.magento.com/user-guide/shipping/shipping-table-rate.html)
60+
- [How to configure Store Pickup](https://docs.magento.com/user-guide/shipping/shipping-in-store-delivery.html)

0 commit comments

Comments
 (0)