Skip to content

Commit 51213c3

Browse files
ENGCOM-9173: [ReadMe] updated readMe file for EavGraphQl-EncryptionKey modules #33661
2 parents fc0648f + 2262232 commit 51213c3

File tree

6 files changed

+155
-11
lines changed

6 files changed

+155
-11
lines changed

app/code/Magento/EavGraphQl/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1-
# EavGraphQl
1+
# Magento_EavGraphQl module
22

3-
**EavGraphQl** primarily provides the GraphQl module information to generate metadata for Eav attributes.
3+
Magento_EavGraphQl module extends Magento_GraphQl and Magento_Eav modules to provide type and resolver information for GraphQL API.
4+
5+
## Installation details
6+
7+
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).
8+
9+
## Additional information
10+
11+
You can get more information at articles:
12+
13+
- [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql).
14+
- [customAttributeMetadata query](https://devdocs.magento.com/guides/v2.4/graphql/queries/custom-attribute-metadata.html).
15+
- [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html)
Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
1-
Magento\Elasticsearch module allows to use Elastic search engine for product searching capabilities.
2-
The module implements Magento\Search library interfaces.
1+
#Magento_Elasticsearch module
2+
3+
Magento_Elasticsearch module allows using the Elasticsearch engine for the product searching capabilities. This module
4+
provides logic used by other modules implementing newer versions of Elasticsearch, this module by itself only adds
5+
support for Elasticsearch v5.
6+
7+
The module implements Magento_Search library interfaces.
8+
9+
## Installation details
10+
11+
The Magento_Elasticsearch module is one of the base Magento 2 modules. You cannot disable or uninstall this module.
12+
13+
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).
14+
15+
## Structure
16+
17+
`Elasticsearch5/` - the directory that contains solutions for providing ElasticSearch 5.x version.
18+
19+
`SearchAdapter/` - the directory that contains solutions for adapting ElasticSearch query searching.
20+
21+
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).
22+
23+
## Additional information
24+
25+
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).
26+
27+
More information about ElasticSearch are at articles:
28+
29+
- [Configuring Catalog Search](https://docs.magento.com/user-guide/catalog/search-configuration.html).
30+
- [Installation Guide/Elasticsearch](https://devdocs.magento.com/guides/v2.4/install-gde/prereq/elasticsearch.html).
31+
- [Configure and maintain Elasticsearch](https://devdocs.magento.com/guides/v2.4/config-guide/elasticsearch/es-overview.html).
32+
- Magento Commerce Cloud - [set up Elasticsearch service](https://devdocs.magento.com/cloud/project/services-elastic.html).
Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
1-
Magento\Elasticsearch module allows to use Elastic search engine (v6) for product searching capabilities.
2-
The module implements Magento\Search library interfaces.
1+
#Magento_Elasticsearch6 module
2+
3+
Magento_Elasticsearch6 module allows using ElasticSearch engine 6.x version for the product searching capabilities.
4+
5+
The module implements Magento_Search library interfaces.
6+
7+
## Installation details
8+
9+
The Magento_Elasticsearch6 module is one of the base Magento 2 modules. Disable or uninstall this module is not recommends.
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+
## Additional information
14+
15+
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).
16+
17+
More information about ElasticSearch are at articles:
18+
19+
- [Configuring Catalog Search](https://docs.magento.com/user-guide/catalog/search-configuration.html).
20+
- [Installation Guide/Elasticsearch](https://devdocs.magento.com/guides/v2.4/install-gde/prereq/elasticsearch.html).
21+
- [Configure and maintain Elasticsearch](https://devdocs.magento.com/guides/v2.4/config-guide/elasticsearch/es-overview.html).
22+
- Magento Commerce Cloud - [set up Elasticsearch service](https://devdocs.magento.com/cloud/project/services-elastic.html).
Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
1-
Magento\Elasticsearch7 module allows to use Elastic search engine (v7) for product searching capabilities.
2-
The module implements Magento\Search library interfaces.
1+
#Magento_Elasticsearch7 module
2+
3+
Magento_Elasticsearch7 module allows using ElasticSearch engine 7.x version for the product searching capabilities.
4+
5+
The module implements Magento_Search library interfaces.
6+
7+
## Installation details
8+
9+
The Magento_Elasticsearch7 module is one of the base Magento 2 modules. Disable or uninstall this module is not recommends.
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+
## Structure
14+
15+
`SearchAdapter/` - the directory that contains solutions for adapting ElasticSearch query searching.
16+
17+
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).
18+
19+
## Additional information
20+
21+
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).
22+
23+
More information about ElasticSearch are at articles:
24+
25+
- [Configuring Catalog Search](https://docs.magento.com/user-guide/catalog/search-configuration.html).
26+
- [Installation Guide/Elasticsearch](https://devdocs.magento.com/guides/v2.4/install-gde/prereq/elasticsearch.html).
27+
- [Configure and maintain Elasticsearch](https://devdocs.magento.com/guides/v2.4/config-guide/elasticsearch/es-overview.html).
28+
- Magento Commerce Cloud - [set up Elasticsearch service](https://devdocs.magento.com/cloud/project/services-elastic.html).

app/code/Magento/Email/README.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,40 @@
1-
# Email
1+
# Magento_Email module
22

3-
**Email** enables you to manage email templates, which are used when you send email through the
4-
*\Magento\Framework\Mail\TransportInterface* implementations.
3+
Magento_Email module enables you to manage email templates.
4+
5+
This module adds the page to create/edit email template at the admin side and possibility add/update templates programmatically.
6+
7+
## Installation details
8+
9+
The Magento_Email module is one of the base Magento 2 modules. 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_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).
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_Email 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 configuration files 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 [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).
34+
35+
More information about email templates are at articles:
36+
37+
- [Marketing/Email](https://docs.magento.com/user-guide/marketing/email-templates.html)
38+
- [Email templates list](https://docs.magento.com/user-guide/marketing/email-template-list.html)
39+
- [Customize email templates](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/templates/template-email.html)
40+
- [Migrating custom email templates](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/templates/template-email-migration.html#nested-arrays)
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
1+
#Magento_EncryptionKey module
2+
13
The Magento_EncryptionKey module provides an advanced encryption model to protect passwords and other sensitive data.
4+
5+
## Extensibility
6+
7+
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).
8+
9+
[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.
10+
11+
### Layouts
12+
13+
This module introduces the following layouts and layout handles in the `view/adminhtml/layout` directory:
14+
15+
- `adminhtml_crypt_key_index`
16+
17+
## Additional information
18+
19+
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).
20+
21+
Some more information you can get at [Encryption Key](https://docs.magento.com/user-guide/system/encryption-key.html) article.

0 commit comments

Comments
 (0)