diff --git a/app/code/Magento/EavGraphQl/README.md b/app/code/Magento/EavGraphQl/README.md index d0121a19f2562..bcf9393f34790 100644 --- a/app/code/Magento/EavGraphQl/README.md +++ b/app/code/Magento/EavGraphQl/README.md @@ -1,3 +1,15 @@ -# EavGraphQl +# Magento_EavGraphQl module -**EavGraphQl** primarily provides the GraphQl module information to generate metadata for Eav attributes. +Magento_EavGraphQl module extends Magento_GraphQl and Magento_Eav modules to provide type and resolver information for GraphQL API. + +## Installation details + +For information about enabling or disabling a module in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Additional information + +You can get more information at articles: + +- [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql). +- [customAttributeMetadata query](https://devdocs.magento.com/guides/v2.4/graphql/queries/custom-attribute-metadata.html). +- [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html) diff --git a/app/code/Magento/Elasticsearch/README.md b/app/code/Magento/Elasticsearch/README.md index 280ca29f8337b..6c2322cc5d9d9 100644 --- a/app/code/Magento/Elasticsearch/README.md +++ b/app/code/Magento/Elasticsearch/README.md @@ -1,2 +1,32 @@ -Magento\Elasticsearch module allows to use Elastic search engine for product searching capabilities. -The module implements Magento\Search library interfaces. \ No newline at end of file +#Magento_Elasticsearch module + +Magento_Elasticsearch module allows using the Elasticsearch engine for the product searching capabilities. This module +provides logic used by other modules implementing newer versions of Elasticsearch, this module by itself only adds +support for Elasticsearch v5. + +The module implements Magento_Search library interfaces. + +## Installation details + +The Magento_Elasticsearch module is one of the base Magento 2 modules. 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). + +## Structure + +`Elasticsearch5/` - the directory that contains solutions for providing ElasticSearch 5.x version. + +`SearchAdapter/` - the directory that contains solutions for adapting ElasticSearch query searching. + +For information about a typical file structure of a module in Magento 2, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure). + +## Additional information + +For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html). + +More information about ElasticSearch are at articles: + +- [Configuring Catalog Search](https://docs.magento.com/user-guide/catalog/search-configuration.html). +- [Installation Guide/Elasticsearch](https://devdocs.magento.com/guides/v2.4/install-gde/prereq/elasticsearch.html). +- [Configure and maintain Elasticsearch](https://devdocs.magento.com/guides/v2.4/config-guide/elasticsearch/es-overview.html). +- Magento Commerce Cloud - [set up Elasticsearch service](https://devdocs.magento.com/cloud/project/services-elastic.html). diff --git a/app/code/Magento/Elasticsearch6/README.md b/app/code/Magento/Elasticsearch6/README.md index 8bf95ad95d147..f27371f195fec 100644 --- a/app/code/Magento/Elasticsearch6/README.md +++ b/app/code/Magento/Elasticsearch6/README.md @@ -1,2 +1,22 @@ -Magento\Elasticsearch module allows to use Elastic search engine (v6) for product searching capabilities. -The module implements Magento\Search library interfaces. +#Magento_Elasticsearch6 module + +Magento_Elasticsearch6 module allows using ElasticSearch engine 6.x version for the product searching capabilities. + +The module implements Magento_Search library interfaces. + +## Installation details + +The Magento_Elasticsearch6 module is one of the base Magento 2 modules. Disable or uninstall this module is not recommends. + +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). + +## Additional information + +For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html). + +More information about ElasticSearch are at articles: + +- [Configuring Catalog Search](https://docs.magento.com/user-guide/catalog/search-configuration.html). +- [Installation Guide/Elasticsearch](https://devdocs.magento.com/guides/v2.4/install-gde/prereq/elasticsearch.html). +- [Configure and maintain Elasticsearch](https://devdocs.magento.com/guides/v2.4/config-guide/elasticsearch/es-overview.html). +- Magento Commerce Cloud - [set up Elasticsearch service](https://devdocs.magento.com/cloud/project/services-elastic.html). diff --git a/app/code/Magento/Elasticsearch7/README.md b/app/code/Magento/Elasticsearch7/README.md index f8331665360c5..c484694e7d267 100644 --- a/app/code/Magento/Elasticsearch7/README.md +++ b/app/code/Magento/Elasticsearch7/README.md @@ -1,2 +1,28 @@ -Magento\Elasticsearch7 module allows to use Elastic search engine (v7) for product searching capabilities. -The module implements Magento\Search library interfaces. +#Magento_Elasticsearch7 module + +Magento_Elasticsearch7 module allows using ElasticSearch engine 7.x version for the product searching capabilities. + +The module implements Magento_Search library interfaces. + +## Installation details + +The Magento_Elasticsearch7 module is one of the base Magento 2 modules. Disable or uninstall this module is not recommends. + +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). + +## Structure + +`SearchAdapter/` - the directory that contains solutions for adapting ElasticSearch query searching. + +For information about a typical file structure of a module in Magento 2, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure). + +## Additional information + +For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html). + +More information about ElasticSearch are at articles: + +- [Configuring Catalog Search](https://docs.magento.com/user-guide/catalog/search-configuration.html). +- [Installation Guide/Elasticsearch](https://devdocs.magento.com/guides/v2.4/install-gde/prereq/elasticsearch.html). +- [Configure and maintain Elasticsearch](https://devdocs.magento.com/guides/v2.4/config-guide/elasticsearch/es-overview.html). +- Magento Commerce Cloud - [set up Elasticsearch service](https://devdocs.magento.com/cloud/project/services-elastic.html). diff --git a/app/code/Magento/Email/README.md b/app/code/Magento/Email/README.md index f6e3512588197..d2c6a4e6901c2 100644 --- a/app/code/Magento/Email/README.md +++ b/app/code/Magento/Email/README.md @@ -1,4 +1,40 @@ -# Email +# Magento_Email module -**Email** enables you to manage email templates, which are used when you send email through the -*\Magento\Framework\Mail\TransportInterface* implementations. +Magento_Email module enables you to manage email templates. + +This module adds the page to create/edit email template at the admin side and possibility add/update templates programmatically. + +## Installation details + +The Magento_Email module is one of the base Magento 2 modules. 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_Email module. For more information about the Magento extension mechanism, see [Magento plugins](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_Email 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 configuration files 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 [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html). + +More information about email templates are at articles: + +- [Marketing/Email](https://docs.magento.com/user-guide/marketing/email-templates.html) +- [Email templates list](https://docs.magento.com/user-guide/marketing/email-template-list.html) +- [Customize email templates](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/templates/template-email.html) +- [Migrating custom email templates](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/templates/template-email-migration.html#nested-arrays) diff --git a/app/code/Magento/EncryptionKey/README.md b/app/code/Magento/EncryptionKey/README.md index b90ea34fdf478..ee28c66b80c4c 100644 --- a/app/code/Magento/EncryptionKey/README.md +++ b/app/code/Magento/EncryptionKey/README.md @@ -1 +1,21 @@ +#Magento_EncryptionKey module + The Magento_EncryptionKey module provides an advanced encryption model to protect passwords and other sensitive data. + +## Extensibility + +Extension developers can interact with the Magento_EncryptionKey module. For more information about the Magento extension mechanism, see [Magento plugins](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_EncryptionKey module. + +### Layouts + +This module introduces the following layouts and layout handles in the `view/adminhtml/layout` directory: + +- `adminhtml_crypt_key_index` + +## Additional information + +For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html). + +Some more information you can get at [Encryption Key](https://docs.magento.com/user-guide/system/encryption-key.html) article.