-
Notifications
You must be signed in to change notification settings - Fork 9.4k
[ReadMe] updated readMe file for EavGraphQl-EncryptionKey modules #31787
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[ReadMe] updated readMe file for EavGraphQl-EncryptionKey modules #31787
Conversation
Hi @korovitskyi. Thank you for your contribution
❗ Automated tests can be triggered manually with an appropriate comment:
You can find more information about the builds here ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review. For more details, please, review the Magento Contributor Guide documentation. 🕙 You can find the schedule on the Magento Community Calendar page. 📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket. 🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel ✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel |
@magento run all tests |
The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time. |
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.
Thank you for your contribution! I added a few comments to the newly introduced content, please review and make adjustments, but the overall effect looks good!
|
||
**EavGraphQl** primarily provides the GraphQl module information to generate metadata for Eav attributes. | ||
Magento_EavGraphQl module extends Magento_GraphQl and Magento_Eav modules to provides type and resolver information for GraphQL API. |
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.
Please fix double space before the "GraphQL" word and change "to provides" either to "and provides" or "to provide".
#Magento_Elasticsearch module | ||
|
||
Magento_Elasticsearch module allows using Elastic search engine for the product searching capabilities. |
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.
Please rephrase to "using the Elasticsearch search engine", "Using the Elasticsearch engine" or something similar as the service is called Elasticsearch (not "Elastic" or "Elastic search").
Please also 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
@@ -1 +1,9 @@ | |||
#Magento_EncryptionKey module |
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.
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 - adminhtml_crypt_key_index
Hi, @bgorski . |
|
||
**EavGraphQl** primarily provides the GraphQl module information to generate metadata for Eav attributes. | ||
Magento_EavGraphQl module extends Magento_GraphQl and Magento_Eav modules to provides type and resolver information for GraphQL API. |
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"
#Magento_Elasticsearch module | ||
|
||
Magento_Elasticsearch module allows using the Elasticsearch engine for the product searching capabilities. |
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.
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
@korovitskyi you missed two things, though, so I re-added those parts of those comments. Please handle those as well. Thanks! We're getting closer! |
Hi @korovitskyi, thank you for your contribution! |
Description (*)
Update README.md file for modules:
Fixed Issues (if relevant)
Contribution checklist (*)