EQPS-908: Devdocs for EQP MFTF Tests - Editable branch #8738

dobooth · 2021-02-24T20:51:59Z

Purpose of this pull request

This pull request (PR) adds pages for new EQP test types to Marketplace EQP Sellers pages. These Types are MFTF Vendor Supplied tests and MFTF Magento Tests

Affected DevDocs pages

Adds new pages here: https://devdocs.magento.com/marketplace/sellers/

Replaces #8663

whatsnew
Added the MFTF Magento-supplied Tests and MFTF Vendor-supplied Tests topics to the Marketplace Sellers guide.

- Added docs for MFTF Vendor Supplied and MFTF Magento tests in EQP

Added missing content

-Added missing content

Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>

- Updated Marketplace Sellers TOC to link to new pages

- Updated technical review guidelines page to reference new MFTF tests

…qp/devdocs into EQPS-908-MFTF-EQP-DOCS

EQPS-908: Devdocs for EQP MFTF Tests

BarnyShergold

Very minor changes

BarnyShergold · 2021-02-24T21:12:44Z

src/marketplace/sellers/mftf-magento.md

+MFTF Magento supplied Tests will be run for all Marketplace extension submissions for:
+
+-  Magento in 2.3 and 2.4 release lines
+-  OpenSource and Commerce editions


Suggested change

- OpenSource and Commerce editions

- Open Source and Commerce editions

BarnyShergold · 2021-02-24T21:13:20Z

src/marketplace/sellers/mftf-magento.md

+
+## Reading the error report
+
+-  MFTF returns two types of results


Suggested change

- MFTF returns two types of results

- MFTF returns two types of results:

BarnyShergold · 2021-02-24T21:14:47Z

src/marketplace/sellers/mftf-magento.md

+-  Remember that MFTF tests will be part of the final package that is made available to your customers
+-  Do not include any sensitive or confidential data in test comments or code
+-  If necessary, include a README or other instructions, within the `Test` directory, to explain any setup steps or caveats on running your MFTF tests
+-  Ensure that any necessary credentials, user authorization (e.g. to communicate via API key to your backend) is explained and supported via Credential management in Tests


Suggested change

- Ensure that any necessary credentials, user authorization (e.g. to communicate via API key to your backend) is explained and supported via Credential management in Tests

- Ensure that any necessary credentials, user authorization (e.g. to communicate via API key to your backend) is explained and supported via credential management in Tests

vkublytskyi · 2021-02-25T16:02:09Z

@dobooth, what are the next steps for this PR? What should be done to have these pages published?

vkublytskyi · 2021-02-25T17:03:32Z

@dobooth I would ask you to revert your latest structural changes as it breaks semantic and inconsistent with other EQP tools documentation.

We have predefined sections for each tool:

Overview - general description of check
What testing is for - describes why we have this check in place
When testing is done - describes what conditions should be satisfied for check execution or skip
What is being checked - describes the scope of check
Tools and environments used - describes how we build our testing environment
Reading the error report - explain how to interpret information returned by the tool
Troubleshooting - describes how to avoid failures, and what to do if a reported error has no clear root cause

dobooth · 2021-02-25T19:32:50Z

@magento import code to magento-devdocs/devdocs

magento-engcom-team · 2021-02-25T19:33:33Z

@dobooth the branch with code successfully imported intomagento-devdocs/devdocs repository. Branch name: imported-magento-devdocs-8738.

…s_edit

dobooth · 2021-02-25T22:15:15Z

running tests

ghost · 2021-02-25T22:37:15Z

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

vkublytskyi · 2021-02-26T01:59:55Z

@dobooth, @keharper During technical review were made following errors which I consider as critical:

Section of "When testing is done" for both new pages are:

The MFTF tests are run as a regular part of the installation and Varnish testing process.

This is technically not correct and misleading users as these checks run in parallel with Installation and Varnish tests and fully isolated from each other

Original text was

MFTF vendor supplied Tests are run only where:

There are MFTF tests included in the submission in the correct directory (Tests/Mftf)

Only for MFTF v3.0 or greater

Only for Magento v2.4.0 or greater

MFTF Magento supplied Tests will be run for all Marketplace extension submissions for:

Magento in 2.3 and 2.4 release lines

OpenSource and Commerce editions

Page https://devdocs.magento.com/marketplace/sellers/mftf-vendor.html has duplicated section What is being checked

Therefore we will create tomorrow new PR with the necessary fixes. Hope we will be able to process it quickly so users will have the best experience with reading our docs.

CC @magterskine

magterskine and others added 13 commits February 9, 2021 17:08

EQPS-908: DEvdocs for EQP MFTF Tests

fe33e6d

- Added docs for MFTF Vendor Supplied and MFTF Magento tests in EQP

Update mftf-magento.md

2907984

Added missing content

Update mftf-vendor.md

5f01423

-Added missing content

Fix indenting for linter

a2bd1a0

Updated with review suggested changes

6c31970

Updates from linter errors

de84437

Removed a single space

0d1b9e1

Apply suggestions from code review

3d3c5de

Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>

Apply suggestions from code review 2

531cd3f

Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>

EQPS-908: Devdocs for EQP MFTF Tests

2b6b4e5

- Updated Marketplace Sellers TOC to link to new pages

EQPS-908: Devdocs for EQP MFTF Tests

bbf120e

- Updated technical review guidelines page to reference new MFTF tests

Merge branch 'EQPS-908-MFTF-EQP-DOCS' of https://github.com/magento-e…

485c78e

…qp/devdocs into EQPS-908-MFTF-EQP-DOCS

Merge pull request #8663 from magento-eqp/EQPS-908-MFTF-EQP-DOCS

7913049

EQPS-908: Devdocs for EQP MFTF Tests

m2-community-project bot added the Progress: ready for review label Feb 24, 2021

Merge branch 'master' into db_eqps_edit

e260aa0

BarnyShergold suggested changes Feb 24, 2021

View reviewed changes

m2-community-project bot assigned BarnyShergold Feb 24, 2021

m2-community-project bot added Progress: changes requested and removed Progress: ready for review labels Feb 24, 2021

Big editorial pass

2343678

dobooth added 4 commits February 25, 2021 12:29

Updated link format

e7fbf49

TOC tweak

3f74618

Editorial pass on guidelines

c06f99e

Lint

eb2ed2f

dobooth added 2 commits February 25, 2021 15:19

Went back to old template

2ee9b29

Merge branch 'db_eqps_edit' of github.com:magento/devdocs into db_eqp…

91a0c98

…s_edit

dobooth added the New Topic A major update published as an entirely new document label Feb 25, 2021

dobooth requested a review from BarnyShergold February 25, 2021 20:25

keharper added 2 commits February 25, 2021 15:51

minor edits

eaf4dcd

Update mftf-vendor.md

f8b1f7a

m2-community-project bot assigned keharper Feb 25, 2021

keharper approved these changes Feb 25, 2021

View reviewed changes

m2-community-project bot added Progress: approved and removed Progress: changes requested labels Feb 25, 2021

dobooth added 2 commits February 25, 2021 17:05

Trailing space.

497de52

Merge branch 'master' into db_eqps_edit

ff6a62e

dobooth enabled auto-merge February 25, 2021 22:15

dobooth merged commit 5e1411d into master Feb 25, 2021

dobooth deleted the db_eqps_edit branch February 25, 2021 22:37

m2-community-project bot added Progress: done and removed Progress: approved labels Feb 25, 2021

jeff-matthews added the Internal Dev Differentiates work between community and Magento staff label Mar 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EQPS-908: Devdocs for EQP MFTF Tests - Editable branch #8738

EQPS-908: Devdocs for EQP MFTF Tests - Editable branch #8738

dobooth commented Feb 24, 2021 •

edited by keharper

Loading

BarnyShergold left a comment

BarnyShergold Feb 24, 2021

BarnyShergold Feb 24, 2021

BarnyShergold Feb 24, 2021

vkublytskyi commented Feb 25, 2021

vkublytskyi commented Feb 25, 2021

dobooth commented Feb 25, 2021

magento-engcom-team commented Feb 25, 2021

dobooth commented Feb 25, 2021

ghost commented Feb 25, 2021

vkublytskyi commented Feb 26, 2021

	- OpenSource and Commerce editions
	- Open Source and Commerce editions


		## Reading the error report

		- MFTF returns two types of results

	- MFTF returns two types of results
	- MFTF returns two types of results:

	- Ensure that any necessary credentials, user authorization (e.g. to communicate via API key to your backend) is explained and supported via Credential management in Tests
	- Ensure that any necessary credentials, user authorization (e.g. to communicate via API key to your backend) is explained and supported via credential management in Tests

EQPS-908: Devdocs for EQP MFTF Tests - Editable branch #8738

EQPS-908: Devdocs for EQP MFTF Tests - Editable branch #8738

Conversation

dobooth commented Feb 24, 2021 • edited by keharper Loading

Purpose of this pull request

Affected DevDocs pages

BarnyShergold left a comment

Choose a reason for hiding this comment

BarnyShergold Feb 24, 2021

Choose a reason for hiding this comment

BarnyShergold Feb 24, 2021

Choose a reason for hiding this comment

BarnyShergold Feb 24, 2021

Choose a reason for hiding this comment

vkublytskyi commented Feb 25, 2021

vkublytskyi commented Feb 25, 2021

dobooth commented Feb 25, 2021

magento-engcom-team commented Feb 25, 2021

dobooth commented Feb 25, 2021

ghost commented Feb 25, 2021

vkublytskyi commented Feb 26, 2021

dobooth commented Feb 24, 2021 •

edited by keharper

Loading