[ReadMe] updated readMe file for ImportExport-LayeredNavigation modules #31809

vlmed · 2021-01-22T15:42:33Z

Description (*)

Update README.md file for modules:

Magento_ImportExport
Magento_Indexer
Magento_InstantPurchase
Magento_Integration
Magento_LayeredNavigation

Fixed Issues (if relevant)

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 · 2021-01-22T15:42:36Z

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

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-27T12:23:14Z

@magento run all tests

bgorski

@vlmed great job, you covered a lot of information here! I added some change requests, but it's clear that you put a lot of work in this already - thank you!

bgorski · 2021-03-27T12:26:52Z

app/code/Magento/ImportExport/README.md

+
+## Installation
+
+The Magento_ImportExport module creates the following tables 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-27T12:36:07Z

app/code/Magento/ImportExport/README.md

+
+### Public APIs
+
+- `Magento\ImportExport\Api\Data\ExportInfoInterface`


The ExtendedExportInfoInterface interface is missing from the description. Please add it and describe in a little more detail both data interfaces so the readme provides clear enough info on what's the difference between them without having to look at the actual code.

bgorski · 2021-03-27T12:36:09Z

app/code/Magento/ImportExport/README.md

+    - export data
+
+- `\Magento\ImportExport\Api\ExportManagementInterface`:
+    - get export data


This is a bit misleading. "Export data" above and "get export data" here might suggest that this interface provides a repository-like getter, while in fact it provides logic for executing the actual export.

bgorski · 2021-03-27T12:52:30Z

app/code/Magento/Indexer/README.md

-Magento_Indexer module is a base of Magento Indexing functionality.
+# Magento_Indexer module
+
+This module provides Magento Indexing functionality.
 It allows:


Please improve wording on this. Like:

"It allows to:" and the rest as is

"It allows:" and the rest in present continuous (reading, representing, regenerating, viewing)

bgorski · 2021-03-27T12:59:40Z

app/code/Magento/Indexer/README.md

+
+- `clean_cache_by_tags` event in the `\Magento\Indexer\Model\Indexer\CacheCleaner::cleanCache` method. Parameters:
+    - `object` is a `$this->cacheContext` object (`Magento\Framework\Indexer\CacheContext` class)


Imho this is a bit too detailed and dependent on the implementation. It's good to describe what class it is, but a description that this is the current cache context (instead of using an actual property name of the $this object) would suffice.

bgorski · 2021-03-27T14:53:01Z

app/code/Magento/LayeredNavigation/README.md

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


Please change wording from layouts to layout handles: https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html#layout-over-terms
Additionally, please include some basic info about how the module modifies layouts (things happening in the view/frontend/page_layout directory), but that's actually more suited for Additional Information as this section is about extension points.

bgorski · 2021-03-27T14:53:16Z

app/code/Magento/Integration/README.md

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


Please change wording from layouts to layout handles: https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html#layout-over-terms

bgorski · 2021-03-27T14:54:28Z

app/code/Magento/Indexer/README.md

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


Please change wording from layouts to layout handles: https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html#layout-over-terms

bgorski · 2021-03-27T14:54:54Z

app/code/Magento/ImportExport/README.md

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


Please change wording from layouts to layout handles: https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html#layout-over-terms

bgorski · 2021-03-27T15:00:56Z

app/code/Magento/LayeredNavigation/README.md

+
+## Additional information
+
+More information can get at articles:


Please change the wording of this one to "More information can be found in:" or something similar to make this one grammatically correct

vlmed · 2021-04-21T11:26:02Z

@magento run all tests

vlmed · 2021-04-21T11:31:55Z

@bgorski Thank you for the review. I improved PR according to your recommendation

magento-engcom-team · 2021-05-08T23:16:50Z

Hi @bgorski, thank you for the review.
ENGCOM-9075 has been created to process this Pull Request

engcom-Foxtrot · 2021-05-25T13:34:37Z

@magento run Functional Tests EE

magento-automated-testing · 2021-05-25T13:34:41Z

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.

magento-automated-testing · 2021-05-26T09:01:10Z

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.

engcom-Foxtrot · 2021-05-26T12:13:52Z

@magento run Functional Tests EE

magento-automated-testing · 2021-05-26T12:13:56Z

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.

magento-engcom-team · 2021-05-26T20:03:15Z

Hi @Den4ik, thank you for the review.
ENGCOM-9075 has been created to process this Pull Request

…igation modules #31809

m2-assistant · 2021-06-16T11:04:36Z

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.

vlmed force-pushed the update_readme_import-export_layered-navigation branch from 06987ed to f7b6043 Compare January 22, 2021 15:44

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

m2-community-project bot added the Progress: pending review label Jan 26, 2021

vlmed force-pushed the update_readme_import-export_layered-navigation branch from f7b6043 to 496d9ff Compare February 3, 2021 12:29

bgorski self-requested a review March 27, 2021 12:22

bgorski self-assigned this Mar 27, 2021

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

bgorski requested changes Mar 27, 2021

View reviewed changes

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

bgorski added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Mar 27, 2021

vlmed added 2 commits April 21, 2021 11:17

[ReadMe] updated readMe file for ImportExport-LayeredNavigation modules

b01435e

PR improvement

7f1dd3f

vlmed force-pushed the update_readme_import-export_layered-navigation branch from 496d9ff to 7f1dd3f Compare April 21, 2021 11:25

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

bgorski approved these changes May 8, 2021

View reviewed changes

m2-community-project bot added the Progress: ready for testing label May 8, 2021

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

engcom-Oscar added Progress: ready for testing QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope and removed Progress: extended testing labels May 25, 2021

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

engcom-Foxtrot self-assigned this May 25, 2021

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

Den4ik approved these changes May 26, 2021

View reviewed changes

m2-community-project bot assigned Den4ik May 26, 2021

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

m2-community-project bot added Progress: accept and removed Progress: ready for testing labels May 27, 2021

gabrieldagama mentioned this pull request Jun 16, 2021

Fix for admin shipment, creditmemo, invoice pdf emulation #4451

Closed

magento-engcom-team pushed a commit that referenced this pull request Jun 16, 2021

ENGCOM-9075: [ReadMe] updated readMe file for ImportExport-LayeredNav…

917b87f

…igation modules #31809

magento-engcom-team merged commit 72d551a into magento:2.4-develop Jun 16, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ReadMe] updated readMe file for ImportExport-LayeredNavigation modules #31809

[ReadMe] updated readMe file for ImportExport-LayeredNavigation modules #31809

vlmed commented Jan 22, 2021

m2-assistant bot commented Jan 22, 2021

bgorski commented Mar 27, 2021

bgorski left a comment

bgorski Mar 27, 2021

bgorski Mar 27, 2021

bgorski Mar 27, 2021

bgorski Mar 27, 2021

bgorski Mar 27, 2021

bgorski Mar 27, 2021

bgorski Mar 27, 2021

bgorski Mar 27, 2021

bgorski Mar 27, 2021

bgorski Mar 27, 2021

vlmed commented Apr 21, 2021

vlmed commented Apr 21, 2021

magento-engcom-team commented May 8, 2021

engcom-Foxtrot commented May 25, 2021

magento-automated-testing bot commented May 25, 2021

magento-automated-testing bot commented May 26, 2021

engcom-Foxtrot commented May 26, 2021

magento-automated-testing bot commented May 26, 2021

magento-engcom-team commented May 26, 2021

m2-assistant bot commented Jun 16, 2021


		## Installation

		The Magento_ImportExport module creates the following tables in the database:


		### Public APIs

		- `Magento\ImportExport\Api\Data\ExportInfoInterface`


		- `clean_cache_by_tags` event in the `\Magento\Indexer\Model\Indexer\CacheCleaner::cleanCache` method. Parameters:
		- `object` is a `$this->cacheContext` object (`Magento\Framework\Indexer\CacheContext` class)


		### Layouts

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


		## Additional information

		More information can get at articles:

[ReadMe] updated readMe file for ImportExport-LayeredNavigation modules #31809

[ReadMe] updated readMe file for ImportExport-LayeredNavigation modules #31809

Conversation

vlmed commented Jan 22, 2021

Description (*)

Fixed Issues (if relevant)

Contribution checklist (*)

m2-assistant bot commented Jan 22, 2021

bgorski commented Mar 27, 2021

bgorski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vlmed commented Apr 21, 2021

vlmed commented Apr 21, 2021

magento-engcom-team commented May 8, 2021

engcom-Foxtrot commented May 25, 2021

magento-automated-testing bot commented May 25, 2021

magento-automated-testing bot commented May 26, 2021

engcom-Foxtrot commented May 26, 2021

magento-automated-testing bot commented May 26, 2021

magento-engcom-team commented May 26, 2021

m2-assistant bot commented Jun 16, 2021