Merge pull request #1178 from anzin/1174-change-default-readme-text-o…

…n-the-example-from 1174: Changing default README.md text
magento · Sep 9, 2022 · b4c4899 · b4c4899
2 parents b5dce10 + 393bc81
commit b4c4899
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 17 deletions.
diff --git a/resources/fileTemplates/includes/MD File Description.md.ft b/resources/fileTemplates/includes/MD File Description.md.ft
@@ -1,8 +1,33 @@
-<!---
-    You can describe your module here.
-    We recommend that you add the following information:
-     - implementation details: why and how to use the module, preferably with some example scenarios
-     - any dependencies (usually other modules but could be any important dependencies, libraries, etc)
-     - extension points, APIs, plug-ins, etc
-     - any introduced events
--->
+<font color='red'>**The following example is a complete README for a module Magento_Default:** </font>
+# 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
@@ -1,3 +1,3 @@
 # ${PACKAGE}_${MODULE_NAME} module
 
-#parse("MD File Description.md")
+#include("MD File Description.md")
diff --git a/...neration/generator/ModuleReadmeMdGenerator/generateModuleReadmeMdFile/README.md b/...neration/generator/ModuleReadmeMdGenerator/generateModuleReadmeMdFile/README.md
@@ -1,10 +1,35 @@
 # Foo_Bar module
 
-<!---
-    You can describe your module here.
-    We recommend that you add the following information:
-     - implementation details: why and how to use the module, preferably with some example scenarios
-     - any dependencies (usually other modules but could be any important dependencies, libraries, etc)
-     - extension points, APIs, plug-ins, etc
-     - any introduced events
--->
+<font color='red'>**The following example is a complete README for a module Magento_Default:** </font>
+# 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).