-
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.
[ReadMe] updated readMe file for NewRelicReporting-OfflineShipping mo…
…dules
- Loading branch information
Showing
5 changed files
with
238 additions
and
14 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,2 +1,46 @@ | ||
| Module Magento\NewRelicReporting 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. | ||
| # Magento_NewRelicReporting module | ||
|
|
||
| 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. | ||
|
|
||
| ## Installation | ||
|
|
||
| Before installing this module, note that the Magento_NewRelicReporting is dependent on the following modules: | ||
| - `Magento_Store` | ||
| - `Magento_Customer` | ||
| - `Magento_Backend` | ||
| - `Magento_Catalog` | ||
| - `Magento_ConfigurableProduct` | ||
| - `Magento_Config` | ||
|
|
||
| This module creates the following tables in the database: | ||
| - `reporting_counts` | ||
| - `reporting_module_status` | ||
| - `reporting_orders` | ||
| - `reporting_users` | ||
| - `reporting_system_updates` | ||
|
|
||
| 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_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). | ||
|
|
||
| [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. | ||
|
|
||
| ## Additional information | ||
|
|
||
| [Learn more about New Relic Reporting](https://docs.magento.com/user-guide/reports/new-relic-reporting.html). | ||
|
|
||
| ### Console commands | ||
|
|
||
| The Magento_NewRelicReporting provides console commands: | ||
| - `bin/magento newrelic:create:deploy-marker <message> <change_log> [<user>]` - check the deploy queue for entries and create an appropriate deploy marker | ||
|
|
||
| [Learn more about command's parameters](https://devdocs.magento.com/guides/v2.4/reference/cli/magento.html#newreliccreatedeploy-marker). | ||
|
|
||
| ### Cron options | ||
|
|
||
| Cron group configuration can be set at `etc/crontab.xml`: | ||
| - `magento_newrelicreporting_cron` - runs collecting all new relic reports | ||
|
|
||
| [Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.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,82 @@ | ||
| 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. | ||
| # Magento_Newsletter module | ||
|
|
||
| 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. | ||
|
|
||
| ## Installation | ||
|
|
||
| Before installing this module, note that the Magento_Newsletter is dependent on the following modules: | ||
| - `Magento_Store` | ||
| - `Magento_Customer` | ||
| - `Magento_Eav` | ||
| - `Magento_Widget` | ||
|
|
||
| Before disabling or uninstalling this module, note that the following modules depends on this module: | ||
| - `Magento_NewsletterGraphQl` | ||
|
|
||
| This module creates the following tables in the database: | ||
| - `newsletter_subscriber` | ||
| - `newsletter_template` | ||
| - `newsletter_queue` | ||
| - `newsletter_queue_link` | ||
| - `newsletter_queue_store_link` | ||
| - `newsletter_problem` | ||
|
|
||
| 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_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). | ||
|
|
||
| [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. | ||
|
|
||
| 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` and `view/adminhtml/layout` directories: | ||
| - `view/adminhtml/layout`: | ||
| - `newsletter_problem_block` | ||
| - `newsletter_problem_grid` | ||
| - `newsletter_problem_index` | ||
| - `newsletter_queue_edit` | ||
| - `newsletter_queue_grid` | ||
| - `newsletter_queue_grid_block` | ||
| - `newsletter_queue_index` | ||
| - `newsletter_queue_preview` | ||
| - `newsletter_queue_preview_popup` | ||
| - `newsletter_subscriber_block` | ||
| - `newsletter_subscriber_exportcsv` | ||
| - `newsletter_subscriber_exportxml` | ||
| - `newsletter_subscriber_grid` | ||
| - `newsletter_subscriber_index` | ||
| - `newsletter_template_edit` | ||
| - `newsletter_template_preview` | ||
| - `newsletter_template_preview_popup` | ||
| - `preview` | ||
|
|
||
| - `view/frontend/layout`: | ||
| - `customer_account` | ||
| - `customer_account_create` | ||
| - `newsletter_manage_index` | ||
| - `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). | ||
|
|
||
| ### UI components | ||
|
|
||
| This module extends customer form ui component the configuration file located in the `view/base/ui_component` directory: | ||
| - `customer_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 | ||
|
|
||
| [Learn more about newsletter](https://docs.magento.com/user-guide/marketing/newsletters.html). | ||
|
|
||
| ### Cron options | ||
|
|
||
| Cron group configuration can be set at `etc/crontab.xml`: | ||
| - `newsletter_send_all` - schedules newsletter sending | ||
|
|
||
| [Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.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,15 @@ | ||
| The Magento_NewsletterGraphQl module allows a shopper to subscribe to a newsletter using GraphQL. | ||
| # Magento_NewsletterGraphQl module | ||
|
|
||
| This module allows a shopper to subscribe to a newsletter using GraphQL. | ||
|
|
||
| ## Installation | ||
|
|
||
| Before installing this module, note that the Magento_NewsletterGraphQl is dependent on the Magento_Newsletter 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_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). | ||
|
|
||
| [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. |
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,5 +1,36 @@ | ||
| 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: | ||
| *Bank transfer | ||
| *Cash on delivery | ||
| *Check / Money Order | ||
| *Purchase order | ||
| # Magento_OfflinePayments module | ||
|
|
||
| This module implements the payment methods which do not require interaction with a payment gateway (so called offline methods). | ||
| These methods are the following: | ||
| - Bank transfer | ||
| - Cash on delivery | ||
| - Check / Money Order | ||
| - Purchase order | ||
|
|
||
| ## Installation | ||
|
|
||
| Before installing this module, note that the Magento_OfflinePayments is dependent on the following modules: | ||
| - `Magento_Store` | ||
| - `Magento_Catalog` | ||
|
|
||
| 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_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). | ||
|
|
||
| [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. | ||
|
|
||
| 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_index_index` | ||
| - `multishipping_checkout_billing` | ||
|
|
||
| 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 Offline Payment Methods](https://docs.magento.com/user-guide/payment/offline-payment-methods.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,6 +1,60 @@ | ||
| 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: | ||
| *Free Shipping | ||
| *Flat Rate | ||
| *Table Rates | ||
| *Store Pickup | ||
| # Magento_OfflineShipping module | ||
|
|
||
| This module implements the shipping methods which do not involve a direct interaction with shipping carriers, so called offline shipping methods. | ||
| Namely, the following: | ||
| - Free Shipping | ||
| - Flat Rate | ||
| - Table Rates | ||
| - Store Pickup | ||
|
|
||
| ## Installation | ||
|
|
||
| Before installing this module, note that the Magento_OfflineShipping is dependent on the following modules: | ||
| - `Magento_Store` | ||
| - `Magento_Sales` | ||
| - `Magento_Quote` | ||
| - `Magento_Quote` | ||
| - `Magento_SalesRule` | ||
|
|
||
| The Magento_OfflineShipping module creates the `shipping_tablerate` table in the database. | ||
|
|
||
| This module modifies the following tables in the database: | ||
| - `salesrule` - adds column `simple_free_shipping` | ||
| - `sales_order_item` - adds column `free_shipping` | ||
| - `quote_address` - adds column `free_shipping` | ||
| - `quote_item` - adds column `free_shipping` | ||
| - `quote_address_item` - adds column `free_shipping` | ||
|
|
||
| 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_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). | ||
|
|
||
| [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. | ||
|
|
||
| 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` | ||
|
|
||
| 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: | ||
| - `sales_rule_form` | ||
| - `salesrulestaging_update_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 | ||
|
|
||
| You can get more information about offline shipping methods in magento at the articles: | ||
| - [How to configure Free Shipping](https://docs.magento.com/user-guide/shipping/shipping-free.html) | ||
| - [How to configure Flat Rate](https://docs.magento.com/user-guide/shipping/shipping-flat-rate.html) | ||
| - [How to configure Table Rates](https://docs.magento.com/user-guide/shipping/shipping-table-rate.html) | ||
| - [How to configure Store Pickup](https://docs.magento.com/user-guide/shipping/shipping-in-store-delivery.html) |