Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Move MFTF reference files from MFTF repo to devdocs [Do not Merge] #6560

Merged
merged 9 commits into from
Feb 11, 2020

Conversation

dobooth
Copy link
Contributor

@dobooth dobooth commented Feb 5, 2020

Purpose of this pull request

This pull request (PR) moves two auto-generated reference topics from MFTF to devdocs reference section.
This simplifies dependencies between repos and it more consistent with devdocs guidelines.

  • Requires another PR to be merged on MFTF repo before we can merge this one.

Affected DevDocs pages

@dobooth dobooth added Site Improvements Updates to tools, processes, and site architecture that improve reader and contributor experience 2.3.x Magento 2.3 related changes labels Feb 5, 2020
@dobooth dobooth requested a review from dshevtsov February 5, 2020 16:56
@dobooth dobooth self-assigned this Feb 5, 2020
This page lists all current action groups so developers can see what is available to them.

## Action group list

Copy link
Collaborator

Choose a reason for hiding this comment

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

It would be nice to have here some explanation of what this list contains such as:
This list is grouped by a module. One module can have multiple XML files each of which contains one or more action groups. To learn more about action groups, refer to Action groups

The Action groups topics should contain a link to this reference.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Similar for the Functional tests topic.


#### [{{ file.filename }}]({{file.repo}})

{% for test in file.actiongroups %}
Copy link
Collaborator

Choose a reason for hiding this comment

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

use actiongroup instead of test as a name of the object

## Action group list

{% assign actiongroups = site.data.codebase.mftf.action-groups | group_by: "module" | sort: "name" %}
{% for item in actiongroups %}
Copy link
Collaborator

Choose a reason for hiding this comment

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

use module instead of item as a name of the object

{% assign actiongroups = site.data.codebase.mftf.action-groups | group_by: "module" | sort: "name" %}
{% for item in actiongroups %}

### {{ item.name }}
Copy link
Collaborator

Choose a reason for hiding this comment

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

This makes the list to be a list of files, not the list of action groups.
Consider making this an action group name. The file name with a link to the source code would go then to metadata.
Add sorting for the action groups.

Consider the same for functional tests.

@dobooth
Copy link
Contributor Author

dobooth commented Feb 11, 2020

running tests

@dobooth dobooth merged commit 6e04144 into master Feb 11, 2020
@ghost
Copy link

ghost commented Feb 11, 2020

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.

@dobooth dobooth deleted the db_mftf_ref_move branch February 11, 2020 19:11
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.3.x Magento 2.3 related changes Site Improvements Updates to tools, processes, and site architecture that improve reader and contributor experience
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants