Skip to content

[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

Closed
wants to merge 2 commits into from
Closed

[ReadMe] updated readMe file for EavGraphQl-EncryptionKey modules #31787

wants to merge 2 commits into from

Conversation

korovitskyi
Copy link
Collaborator

Description (*)

Update README.md file for modules:

  • Magento_EavGraphQl;
  • Magento_Elasticsearch;
  • Magento_Elasticsearch6;
  • Magento_Elasticsearch7;
  • Magento_Email;
  • Magento_EncryptionKey.

Fixed Issues (if relevant)

  1. magento/devdocs README content for modules - work in M2 Code devdocs#4451: README content for modules - work in M2 Code

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • All automated tests passed successfully (all builds are green)

@m2-assistant
Copy link

m2-assistant bot commented Jan 20, 2021

Hi @korovitskyi. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

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.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 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

@gabrieldagama gabrieldagama added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label May 25, 2021
@bgorski bgorski self-requested a review June 12, 2021 17:28
@bgorski bgorski self-assigned this Jun 12, 2021
@bgorski
Copy link
Contributor

bgorski commented Jun 12, 2021

@magento run all tests

@magento-automated-testing
Copy link

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.

Copy link
Contributor

@bgorski bgorski left a 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.
Copy link
Contributor

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.
Copy link
Contributor

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
Copy link
Contributor

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

@korovitskyi
Copy link
Collaborator Author

Hi, @bgorski .
The changes were added.
Thank you for the review.


**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.
Copy link
Contributor

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.
Copy link
Contributor

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

@bgorski
Copy link
Contributor

bgorski commented Jul 8, 2021

@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!

@korovitskyi
Copy link
Collaborator Author

Hi, @bgorski .
This PR was reopened at #33661.
I have trouble with the fork, so it was needed to recreate it.
Thank you for the review.

@korovitskyi korovitskyi closed this Aug 2, 2021
@m2-assistant
Copy link

m2-assistant bot commented Aug 2, 2021

Hi @korovitskyi, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: EavGraphQl Component: Elasticsearch Component: Email Component: EncryptionKey Partner: Atwix Pull Request is created by partner Atwix partners-contribution Pull Request is created by Magento Partner Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Release Line: 2.4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants