|
1 |
| -<!--- |
2 |
| - You can describe your module here. |
3 |
| - We recommend that you add the following information: |
4 |
| - - implementation details: why and how to use the module, preferably with some example scenarios |
5 |
| - - any dependencies (usually other modules but could be any important dependencies, libraries, etc) |
6 |
| - - extension points, APIs, plug-ins, etc |
7 |
| - - any introduced events |
8 |
| ---> |
| 1 | +<font color='red'>**The following example is a complete README for a module Magento_Default:** </font> |
| 2 | +# Magento_Default module |
| 3 | +The Magento_Default module enables you to add the Configurable Product updates to the existing store campaigns. |
| 4 | + |
| 5 | +The Magento_Default module is a part of the staging functionality in Magento EE. The module adds the “Configurations” tab and the configuration wizard to the Schedule Update form of a product. You can change the Configurable Product attributes in campaigns. These updates are shown on the campaign dashboard. |
| 6 | + |
| 7 | +## Installation details |
| 8 | + |
| 9 | +The Magento_Default module makes irreversible changes in a database during installation. You cannot disable or uninstall 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_Default 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). |
| 16 | + |
| 17 | +[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_Default module. |
| 18 | + |
| 19 | +### Layouts |
| 20 | + |
| 21 | +The module introduces layout handles in the `view/adminhtml/layout` directory. |
| 22 | + |
| 23 | +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). |
| 24 | + |
| 25 | +### UI components |
| 26 | + |
| 27 | +You can extend product and category updates using the UI components located in the `view/adminhtml/ui_component` directory. |
| 28 | + |
| 29 | +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). |
| 30 | + |
| 31 | +## Additional information |
| 32 | + |
| 33 | +For information about significant changes in patch releases, see [Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html). |
0 commit comments