[ReadMe] updated readMe file for Persistent-QuoteAnalitics #32356

vlmed · 2021-03-03T15:56:44Z

Description (*)

Update README.md file for modules:

Magento_Persistent
Magento_ProductAlert
Magento_ProductVideo
Magento_Quote
Magento_QuoteAnalitics

Fixed Issues (if relevant)

magento/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 · 2021-03-03T15:56:47Z

Hi @vlmed. Thank you for your contribution
Here are 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:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
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

bgorski · 2021-03-23T18:40:03Z

app/code/Magento/Persistent/README.md

-Magento\Persistent module enables set customer a long-term cookie containing internal id (random hash - to exclude brute
+# Magento_Persistent module
+
+This module enables set customer a long-term cookie containing internal id (random hash - to exclude brute


Please rephrase this to "this module enables setting ... for a customer" or something similar. "This module enables set customer ..." doesn't look valid.

bgorski · 2021-03-23T20:05:11Z

app/code/Magento/Persistent/README.md

+- `Magento_Checkout`
+- `Magento_PageCache`
+
+The Magento_Persistent module creates the `persistent_session` table in the database.


Please add some information about the schema/column not being persistent (e.g. not having to be manually removed) when the module gets disabled and setup:upgrade is run.

bgorski · 2021-03-23T20:13:20Z

app/code/Magento/ProductAlert/README.md

+
+This module enables product alerts, which allow customers to sign up for emails about product price or stock status change.
+
+## Installation


Please add some information about the schema/column not being persistent (e.g. not having to be manually removed) when the module gets disabled and setup:upgrade is run.
Additionally, please add information about the recurring script in the module and if its modification need to be manually reverted upon uninstallation.

bgorski · 2021-03-23T20:16:21Z

app/code/Magento/ProductVideo/README.md

+- `Magento_Catalog`
+- `Magento_Backend`
+
+The Magento_ProductVideo module creates the `catalog_product_entity_media_gallery_value_video` table in the database.


Please add some information about the schema/column not being persistent (e.g. not having to be manually removed) when the module gets disabled and setup:upgrade is run.

bgorski · 2021-03-23T20:22:05Z

app/code/Magento/Quote/README.md

-The Magento_Quote module does not have any specific system requirements.
+The Magento_Quote module is one of the base Magento 2 modules. You cannot disable or uninstall this module.
+
+The following modules depend on this module:


I'm not sure if listing dependent modules here is a good idea. The README.md file obviously requires more maintenance now. However, it's relatively easy to maintain it when changes are made inside the module itself, but can be challenging in case of this list as it would require maintaining it when other modules are modified or added. Sometimes that would require adding commits/PRs to more than one project (e.g. if a new EE module depends on this one).

bgorski · 2021-03-23T20:26:43Z

app/code/Magento/ProductAlert/README.md

+- `Magento_Catalog`
+- `Magento_Customer`
+
+The Magento_ProductAlert module creates the following table in the database:


A typo - "table" should be "tables"

bgorski · 2021-03-23T20:27:46Z

app/code/Magento/Quote/README.md

+- `Magento_SalesRule`
+- `Magento_Weee`
+
+The Magento_Quote module creates the following table in the database:


Please add some information about the schema/column not being persistent (e.g. not having to be manually removed) when the module gets disabled and setup:upgrade is run.

Also - a typo - "table" should be in the plural form.

Additionally, please cover all the data patches here and mention if modifications introduced in them can have to be manually removed/reverted after the module uninstallation.

I don't think we should mention any schema / data reverting as this module should not be disabled or removed.

bgorski · 2021-03-23T20:34:01Z

app/code/Magento/Quote/README.md

+
+#### Guest
+
+- `\Magento\Quote\Api\GuestBillingAddressManagementInterfacee`


a typo - Interfacee instead of Interface (not that it matters that much, but still)

bgorski · 2021-03-23T20:37:30Z

app/code/Magento/QuoteAnalytics/README.md

-The Magento_QuoteAnalytics module configures data definitions for a data collection related to the Quote module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.4/advanced-reporting/modules.html).
+This module configures data definitions for a data collection related to the Quote module entities to be used in [Advanced Reporting](https://devdocs.magento.com/guides/v2.3/advanced-reporting/modules.html).
+
+## Installation


Please add a mention that this module doesn't introduce any db modifications or new data (so everyone reading the readme knows that this is what happens - a lack of any mention might be considered just an omission, not as info that nothing gets added).

bgorski · 2021-03-23T20:44:06Z

@vlmed good job adding all those readme files! I had a few comments, but the overall effect looks great!

bgorski · 2021-03-23T21:33:51Z

@magento run all tests

bgorski · 2021-03-24T22:43:16Z

@magento run WebAPI Tests, Unit Tests, Functional Tests B2B

bgorski · 2021-03-27T15:10:44Z

app/code/Magento/Persistent/README.md

+
+### Layouts
+
+This module introduces the following layouts in the `view/frontend/layout` directory:


Actually it doesn't introduce those - it's only a "client" of layout handles introduced by Magneto_Customer - please remove them from here.
I initially haven't noticed that this comment should be added here, but better late than never.

…tics.

engcom-Foxtrot · 2021-04-16T13:31:51Z

@magento run all tests

engcom-Foxtrot · 2021-04-16T13:33:11Z

@bgorski updated, please review.

magento-engcom-team · 2021-04-18T16:57:48Z

Hi @bgorski, thank you for the review.
ENGCOM-9026 has been created to process this Pull Request
✳️ @bgorski, could you please add one of the following labels to the Pull Request?

Label	Description
`Auto-Tests: Covered`	All changes in Pull Request is covered by auto-tests
`Auto-Tests: Not Covered`	Changes in Pull Request requires coverage by auto-tests
`Auto-Tests: Not Required`	Changes in Pull Request does not require coverage by auto-tests

engcom-Foxtrot · 2021-04-20T13:32:25Z

False-positive Functional Tests EE failure. PR changes cannot affect MFTF tests as it's only modifying readme files.

#32356

m2-assistant · 2021-04-26T22:56:54Z

Hi @vlmed, 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.

[ReadMe] updated readMe file for Persistent-QuoteAnalitics

889703b

magento-engcom-team added Component: Persistent Component: ProductVideo Component: ProductAlert Component: Quote Component: QuoteAnalytics Release Line: 2.4 Partner: Atwix Pull Request is created by partner Atwix partners-contribution Pull Request is created by Magento Partner labels Mar 3, 2021

gabrieldagama added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Mar 4, 2021

m2-community-project bot added the Progress: pending review label Mar 4, 2021

bgorski self-assigned this Mar 23, 2021

m2-community-project bot added Progress: review and removed Progress: pending review labels Mar 23, 2021

bgorski self-requested a review March 23, 2021 18:32

bgorski requested changes Mar 23, 2021

View reviewed changes

m2-community-project bot added Progress: needs update and removed Progress: review labels Mar 23, 2021

bgorski reviewed Mar 27, 2021

View reviewed changes

m2-community-project bot added Progress: review and removed Progress: needs update labels Mar 27, 2021

bgorski added the Progress: needs update label Apr 2, 2021

m2-community-project bot removed the Progress: review label Apr 2, 2021

magento#32356: [ReadMe] updated readMe file for Persistent-QuoteAnali…

50389ce

…tics.

m2-community-project bot assigned engcom-Foxtrot Apr 16, 2021

m2-community-project bot added Progress: review and removed Progress: needs update labels Apr 16, 2021

engcom-Foxtrot requested a review from bgorski April 16, 2021 13:36

m2-community-project bot added Progress: pending review and removed Progress: review labels Apr 16, 2021

bgorski approved these changes Apr 18, 2021

View reviewed changes

m2-community-project bot added Progress: ready for testing and removed Progress: pending review labels Apr 18, 2021

m2-community-project bot added Progress: extended testing and removed Progress: ready for testing labels Apr 19, 2021

m2-community-project bot added Progress: accept Progress: ready for testing and removed Progress: extended testing Progress: accept Progress: ready for testing labels Apr 20, 2021

magento-engcom-team pushed a commit that referenced this pull request Apr 26, 2021

ENGCOM-9026: [ReadMe] updated readMe file for Persistent-QuoteAnalitics

67f0b71

#32356

magento-engcom-team merged commit 62ec278 into magento:2.4-develop Apr 26, 2021

magento-engcom-team added the Event: Adobe Summit Hackathon label Apr 26, 2021


		This module enables product alerts, which allow customers to sign up for emails about product price or stock status change.

		## Installation


		#### Guest

		- `\Magento\Quote\Api\GuestBillingAddressManagementInterfacee`


		### Layouts

		This module introduces the following layouts in the `view/frontend/layout` directory:

[ReadMe] updated readMe file for Persistent-QuoteAnalitics #32356

[ReadMe] updated readMe file for Persistent-QuoteAnalitics #32356

Uh oh!

Conversation

vlmed commented Mar 3, 2021 • edited by gabrieldagama Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Fixed Issues (if relevant)

Contribution checklist (*)

Uh oh!

m2-assistant bot commented Mar 3, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bgorski commented Mar 23, 2021

Uh oh!

bgorski commented Mar 23, 2021

Uh oh!

bgorski commented Mar 24, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

engcom-Foxtrot commented Apr 16, 2021

Uh oh!

engcom-Foxtrot commented Apr 16, 2021

Uh oh!

magento-engcom-team commented Apr 18, 2021

Uh oh!

engcom-Foxtrot commented Apr 20, 2021

Uh oh!

m2-assistant bot commented Apr 26, 2021

Uh oh!

Uh oh!

vlmed commented Mar 3, 2021 •

edited by gabrieldagama

Loading