[ReadMe] updated readMe file for LoginAsCustomer-Marketplace modules

[vlmed]

Description (*)

Update README.md file for modules:

• Magento_LoginAsCustomer
• Magento_LoginAsCustomerAdminUi
• Magento_LoginAsCustomerApi
• Magento_LoginAsCustomerAssistance
• Magento_LoginAsCustomerFrontendUi
• Magento_LoginAsCustomerGraphQl
• Magento_LoginAsCustomerLog
• Magento_LoginAsCustomerPageCache
• Magento_LoginAsCustomerQuote
• Magento_LoginAsCustomerSales
• Magento_Marketplace

Fixed Issues (if relevant)

1. Fixes 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]

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:

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

[bgorski]

@vlmed a great contribution, as always! I had a couple of change requests, please review and address them.
Thanks for the hard work!

[bgorski]

Please remove those that are not introduced by the module but are introduced by other modules and just used by this module.
Also, please be sure to distinguish between layouts and layout handles.

[bgorski]

This comment is still not fully resolved - there's the layouts vs layout handles thing.
When handles are mentioned, it's about those xml files that define the entire page structure - something you can assign your new page and it will look properly, like app/code/Magento/Theme/view/base/page_layout/empty.xml:

<?xml version="1.0"?>
<!--
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
-->
<layout xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_layout.xsd">
    <container name="root">
        <container name="after.body.start" as="after.body.start" before="-" label="Page Top"/>
        <container name="page.wrapper" as="page_wrapper" htmlTag="div" htmlClass="page-wrapper">
            <container name="global.notices" as="global_notices" before="-"/>
            <container name="main.content" htmlTag="main" htmlId="maincontent" htmlClass="page-main">
                <container name="columns.top" label="Before Main Columns"/>
                <container name="columns" htmlTag="div" htmlClass="columns">
                    <container name="main" label="Main Content Container" htmlTag="div" htmlClass="column main"/>
                </container>
            </container>
            <container name="page.bottom.container" as="page_bottom_container" label="Before Page Footer Container" after="main.content" htmlTag="div" htmlClass="page-bottom"/>
            <container name="before.body.end" as="before_body_end" after="-" label="Page Bottom"/>
        </container>
    </container>
</layout>

And you can use them in other layouts or layout handles like this:

<page layout="admin-1column" xmlns:xsi="..." xsi:noNamespaceSchemaLocation="...">
    <body>
        ...

Layouts are usually (not always - see app/code/Magento/Robots/view/frontend/page_layout/robots.xml) defined in layouts.xml files, like this:

<page_layouts xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/PageLayout/etc/layouts.xsd">
    <layout id="1column">
        <label translate="true">1 column</label>
    </layout>
    <layout id="2columns-left">
        <label translate="true">2 columns with left bar</label>
    </layout>
    <layout id="2columns-right">
        <label translate="true">2 columns with right bar</label>
    </layout>
    <layout id="3columns">
        <label translate="true">3 columns</label>
    </layout>
</page_layouts>

They reside in page_layout directories.

Layout handles, which live in layout directories, are similar, but they don't represent full page structure. They may rely on one, but their main function is add instructions that are specific to that handle. There are two types of those - handles that correspond to actions like catalog_product_view.xml (sometimes with additional parameters) and handles that don't do that and contain layout instructions that are shared by multiple other layout handles, which can include them like this:

<layout xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/layout_generic.xsd">
    <update handle="loginascustomer_confirmation_popup" />
</layout>

In this case, loginascustomer_confirmation_popup.xml is not a standalone top-to-bottom layout file. It's a handle. It's referenced by a few other handles in the same directory.

[bgorski]

I don't think this section is necessary as the module only extends but doesn't introduce any ui components.

[vlmed]

Done

[bgorski]

Please add missing API entries.

[vlmed]

@bgorski I only added interfaces with the @api annotation. Should I add all the interfaces from the Api directory?

[bgorski]

Please do. You asked a good question, though - thanks. The @api annotation is only about backwards compatibility and determines when can the code be introduced or removed. You can check https://devdocs.magento.com/contributor-guide/backward-compatible-development/ for reference.
However, as for the Api directory, everything in there is an API, even if some of them are more "protected" than other ones.

[bgorski]

please remove APIs which the module only uses as a client

[vlmed]

I leave loginascustomer_confirmation_popup because this layout is introduced by this module

[bgorski]

I don't think this section is necessary here, the module doesn't introduce any ui components. Please remove.

[vlmed]

Done

[bgorski]

Doesn't really look done :) The customer_form mentioned here is something that this module is a client of, it doesn't own it. This section is only about what's introduced and shouldn't contain those that the module just use.

[bgorski]

Please skip this section as there's nothing to add besides just what the sample provides

[vlmed]

Done

[bgorski]

Please skip this section as there's nothing to add besides just what the sample provides

[vlmed]

Done

[bgorski]

Please skip this section as there's nothing to add besides just what the sample provides

[vlmed]

Done

[bgorski]

Please skip this section as there's nothing to add besides just what the sample provides

[vlmed]

Done

[bgorski]

Please skip this section as there's nothing to add besides just what the sample provides

[vlmed]

Done

[bgorski]

This comment is still not fully resolved - there's the layouts vs layout handles thing.
When handles are mentioned, it's about those xml files that define the entire page structure - something you can assign your new page and it will look properly, like app/code/Magento/Theme/view/base/page_layout/empty.xml:

<?xml version="1.0"?>
<!--
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
-->
<layout xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_layout.xsd">
    <container name="root">
        <container name="after.body.start" as="after.body.start" before="-" label="Page Top"/>
        <container name="page.wrapper" as="page_wrapper" htmlTag="div" htmlClass="page-wrapper">
            <container name="global.notices" as="global_notices" before="-"/>
            <container name="main.content" htmlTag="main" htmlId="maincontent" htmlClass="page-main">
                <container name="columns.top" label="Before Main Columns"/>
                <container name="columns" htmlTag="div" htmlClass="columns">
                    <container name="main" label="Main Content Container" htmlTag="div" htmlClass="column main"/>
                </container>
            </container>
            <container name="page.bottom.container" as="page_bottom_container" label="Before Page Footer Container" after="main.content" htmlTag="div" htmlClass="page-bottom"/>
            <container name="before.body.end" as="before_body_end" after="-" label="Page Bottom"/>
        </container>
    </container>
</layout>

And you can use them in other layouts or layout handles like this:

<page layout="admin-1column" xmlns:xsi="..." xsi:noNamespaceSchemaLocation="...">
    <body>
        ...

Layouts are usually (not always - see app/code/Magento/Robots/view/frontend/page_layout/robots.xml) defined in layouts.xml files, like this:

<page_layouts xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/PageLayout/etc/layouts.xsd">
    <layout id="1column">
        <label translate="true">1 column</label>
    </layout>
    <layout id="2columns-left">
        <label translate="true">2 columns with left bar</label>
    </layout>
    <layout id="2columns-right">
        <label translate="true">2 columns with right bar</label>
    </layout>
    <layout id="3columns">
        <label translate="true">3 columns</label>
    </layout>
</page_layouts>

They reside in page_layout directories.

Layout handles, which live in layout directories, are similar, but they don't represent full page structure. They may rely on one, but their main function is add instructions that are specific to that handle. There are two types of those - handles that correspond to actions like catalog_product_view.xml (sometimes with additional parameters) and handles that don't do that and contain layout instructions that are shared by multiple other layout handles, which can include them like this:

<layout xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/layout_generic.xsd">
    <update handle="loginascustomer_confirmation_popup" />
</layout>

In this case, loginascustomer_confirmation_popup.xml is not a standalone top-to-bottom layout file. It's a handle. It's referenced by a few other handles in the same directory.

[bgorski]

Please do. You asked a good question, though - thanks. The @api annotation is only about backwards compatibility and determines when can the code be introduced or removed. You can check https://devdocs.magento.com/contributor-guide/backward-compatible-development/ for reference.
However, as for the Api directory, everything in there is an API, even if some of them are more "protected" than other ones.

[bgorski]

Doesn't really look done :) The customer_form mentioned here is something that this module is a client of, it doesn't own it. This section is only about what's introduced and shouldn't contain those that the module just use.

[bgorski]

Please see my comment above about layout and layout handles

[vlmed]

@bgorski Thank you for the review. I have implemented all your recommendations. Please, check

[engcom-Charlie]

It seems that, as per this comment the requested changes has been implemented, so moving this ticket to Pending Review.

Thank you!

[bgorski]

Marking as approved. Thank you for the contribution @vlmed!

To whoever is going to test this - I haven't run automated tests on this PR because it touches readme files only, so no functional changes in the code are introduced, therefore tests are irrelevant.

[magento-engcom-team]

Hi @bgorski, thank you for the review.
ENGCOM-9253 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

[m2-assistant]

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.