[ReadMe] updated readMe file for EavGraphQl-EncryptionKey modules #31787
There are no files selected for viewing
This file contains hidden or 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,3 +1,15 @@ | ||
| # Magento_EavGraphQl module | ||
|
|
||
| Magento_EavGraphQl module extends Magento_GraphQl and Magento_Eav modules to provides 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) | ||
This file contains hidden or 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,30 @@ | ||
| #Magento_Elasticsearch module | ||
|
|
||
| Magento_Elasticsearch module allows using the Elasticsearch engine for the product searching capabilities. | ||
|
There was a problem hiding this comment. Please add a note that although it 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). | ||
This file contains hidden or 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,22 @@ | ||
| #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). |
This file contains hidden or 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,28 @@ | ||
| #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). |
This file contains hidden or 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,4 +1,40 @@ | ||
| # Magento_Email module | ||
|
|
||
| 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) |
This file contains hidden or 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,21 @@ | ||
| #Magento_EncryptionKey module | ||
|
There was a problem hiding this comment. Please include the Extensibility section (https://github.com/magento/devdocs/wiki/Magento-module-README.md#extensibility) with the Layout subsection containing an information that this module introduces a new layout handle - |
||
|
|
||
| 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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's still a typo in "provides" - should be "provide"