-
Notifications
You must be signed in to change notification settings - Fork 9.4k
update read me file for Variable, vault, vaultGraphQl, version, webApi modules #31474
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
base: 2.4-develop
Are you sure you want to change the base?
update read me file for Variable, vault, vaultGraphQl, version, webApi modules #31474
Conversation
Hi @chiranjeevi-cj. 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 |
app/code/Magento/Variable/README.md
Outdated
- Magento_Cms | ||
- Magento_Email | ||
|
||
Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html). |
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.
Change all these "Please find here..." to "Refer to [...) for more information."
Co-authored-by: Donald Booth <dobooth@adobe.com>
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.
A few more editorial comments.
|
||
## Installation details | ||
|
||
The Magento_VaultGraphQl is dependent on the following modules: |
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.
The Magento_VaultGraphQl is dependent on the following modules: | |
The Magento_Webapi module is dependent on the following modules: |
Magento\Version Allows to get Magento version and edition by HTTP GET request | ||
# Magento_Version module | ||
|
||
The Magento_Version module allows to get Magento version and edition by HTTP GET request. |
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.
The Magento_Version module allows to get Magento version and edition by HTTP GET request. | |
The Magento_Version module allows retrieval of the Magento version and edition using HTTP GET requests. |
**VaultGraphQl** provides type and resolver information for the GraphQl module | ||
to generate Vault (stored payment information) information endpoints. This module also | ||
provides mutations for modifying a payment token. | ||
The Magento_VaultGraphQl module extends Magento_GraphQl and Magento_Vault modules. |
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.
This shouldn't be the first line. I'm not sure you need it at all, considering the contents of the Installation details section.
Magento\Variable Allows to create custom variables and then use them in email templates or in WYSIWYG editor for editing description of system entities. | ||
# Magento_Variable module | ||
|
||
The Magento_Variable module allows the creation of custom variables for use in email templates or in the WYSIWYG editor when editing descriptions of system entities. |
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.
The Magento_Variable module allows the creation of custom variables for use in email templates or in the WYSIWYG editor when editing descriptions of system entities. | |
The Magento_Variable module allows you to create custom variables for use in email templates or in the WYSIWYG editor when editing descriptions of system entities. |
Description (*)
Update README.md file:
Fixed Issues (if relevant)
Contribution checklist (*)