From d7363052eabd807d9936a84f463cbcfd075196a8 Mon Sep 17 00:00:00 2001 From: "andrii.zinkevych" Date: Fri, 9 Sep 2022 15:08:06 +0300 Subject: [PATCH 1/2] 1174: Changing default README.md text --- .../includes/MD File Description.md.ft | 41 +++++++++++++++---- .../Magento Module Readme File MD.md.ft | 2 +- 2 files changed, 34 insertions(+), 9 deletions(-) diff --git a/resources/fileTemplates/includes/MD File Description.md.ft b/resources/fileTemplates/includes/MD File Description.md.ft index 651f05363..7f16f5008 100644 --- a/resources/fileTemplates/includes/MD File Description.md.ft +++ b/resources/fileTemplates/includes/MD File Description.md.ft @@ -1,8 +1,33 @@ - +**The following example is a complete README for a module Magento_Default:** +# Magento_Default module +The Magento_Default module enables you to add the Configurable Product updates to the existing store campaigns. + +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. + +## Installation details + +The Magento_Default module makes irreversible changes in a database during installation. You cannot disable or uninstall 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_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). + +[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. + +### Layouts + +The module introduces layout handles in the `view/adminhtml/layout` directory. + +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 + +You can extend product and category updates using the UI components located in the `view/adminhtml/ui_component` directory. + +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). + +## Additional information + +For information about significant changes in patch releases, see [Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html). diff --git a/resources/fileTemplates/internal/Magento Module Readme File MD.md.ft b/resources/fileTemplates/internal/Magento Module Readme File MD.md.ft index 34b77754c..ae0e2b64f 100644 --- a/resources/fileTemplates/internal/Magento Module Readme File MD.md.ft +++ b/resources/fileTemplates/internal/Magento Module Readme File MD.md.ft @@ -1,3 +1,3 @@ # ${PACKAGE}_${MODULE_NAME} module -#parse("MD File Description.md") +#include("MD File Description.md") From 393bc81375238a1912a08e91046becf6168db248 Mon Sep 17 00:00:00 2001 From: "andrii.zinkevych" Date: Fri, 9 Sep 2022 15:40:40 +0300 Subject: [PATCH 2/2] 1174: Fixed failed test --- .../generateModuleReadmeMdFile/README.md | 41 +++++++++++++++---- 1 file changed, 33 insertions(+), 8 deletions(-) diff --git a/testData/actions/generation/generator/ModuleReadmeMdGenerator/generateModuleReadmeMdFile/README.md b/testData/actions/generation/generator/ModuleReadmeMdGenerator/generateModuleReadmeMdFile/README.md index 084c0b6e3..7f2121c4b 100644 --- a/testData/actions/generation/generator/ModuleReadmeMdGenerator/generateModuleReadmeMdFile/README.md +++ b/testData/actions/generation/generator/ModuleReadmeMdGenerator/generateModuleReadmeMdFile/README.md @@ -1,10 +1,35 @@ # Foo_Bar module - +**The following example is a complete README for a module Magento_Default:** +# Magento_Default module +The Magento_Default module enables you to add the Configurable Product updates to the existing store campaigns. + +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. + +## Installation details + +The Magento_Default module makes irreversible changes in a database during installation. You cannot disable or uninstall 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_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). + +[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. + +### Layouts + +The module introduces layout handles in the `view/adminhtml/layout` directory. + +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 + +You can extend product and category updates using the UI components located in the `view/adminhtml/ui_component` directory. + +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). + +## Additional information + +For information about significant changes in patch releases, see [Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).