Skip to content

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

Open
wants to merge 13 commits into
base: 2.4-develop
Choose a base branch
from

Conversation

chiranjeevi-cj
Copy link
Contributor

Description (*)

Update README.md file:

  • Magento_Variable
  • Magento_Vault
  • Magento_VaultGraphQl
  • Magento_Version
  • Magento_Webapi

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 Dec 28, 2020

Hi @chiranjeevi-cj. 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

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

@magento-engcom-team magento-engcom-team added Component: Variable Component: Vault Component: VaultGraphQl Component: Version Component: Webapi Use with concrete module component label E.g. "Component: Webapi" + "Catalog" Release Line: 2.4 Partner: EY partners-contribution Pull Request is created by Magento Partner labels Dec 28, 2020
@chiranjeevi-cj
Copy link
Contributor Author

@magento run all tests

@sidolov sidolov added Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Jan 4, 2021
- 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).
Copy link
Contributor

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."

Copy link
Contributor

@keharper keharper left a 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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Variable Component: Vault Component: VaultGraphQl Component: Version Component: Webapi Use with concrete module component label E.g. "Component: Webapi" + "Catalog" Partner: EY 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. Progress: pending review Release Line: 2.4 Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants