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

Commit b13eb12

Browse files
authored
Merge branch 'master' into ds_fix-external-links-2
2 parents 2a96bac + 26cdd8a commit b13eb12

File tree

16 files changed

+5850
-325
lines changed

16 files changed

+5850
-325
lines changed

_data/mftf.yml

Lines changed: 5488 additions & 0 deletions
Large diffs are not rendered by default.

_includes/contributor/labels.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ General labels include a variety of tasks and definitions for pull requests and
7878
* `help wanted` - Indicates the creator or author needs help with a decision, advice for resolving, and so on.
7979
* `triage wanted` - Indicates the issues are under triage. See this information to learn more about the [Triage Wanted program](https://github.com/magento/magento2/wiki/Triage-Wanted).
8080

81-
### Issue Resolution Status
81+
### Issue resolution status
8282
{:.no_toc}
8383

8484
Labels applied to issues through verification and completion. For details on the process, see [GitHub Issues Processing Workflow](https://github.com/magento/magento2/wiki/GitHub-Issues-Processing-Workflow).
@@ -101,7 +101,7 @@ Labels applied to issues through verification and completion. For details on the
101101

102102
All [contributions to DevDocs](https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md) receive the following labels:
103103

104-
* `New topic`- New file submissions for content that has never existed on devdocs
105-
* `Major update` - Significant updates to existing content, such as a new section or example
106-
* `Technical` - Updates to the code or processes that alter the technical content of the document
107-
* `Editorial` - Fixes for typos, grammatical inconsistencies, or minor rewrites to correct inaccuracies.
104+
* `New topic`- New topic submissions for content that has never existed on DevDocs such as tutorials, references, instructions, and so on
105+
* `Major update` - Significant original updates to existing content
106+
* `Technical` - Updates to the code or processes that alter the technical content of the document, such as code snippets, reference documentation, parameter names and values, and other relevant content
107+
* `Editorial` - Fixes for typos, grammatical inconsistencies, or minor rewrites to correct inaccuracies

_includes/contributor/rewards.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ Each PR can earn one of the following additional achievements. If you entered an
7676

7777
Achievement | Points | Description
7878
| ------------ | --- | --- |
79-
New topic | 30 | New file submissions for content that has never existed on devdocs
80-
Major update | 20 | Significant updates to existing content, such as a new section or example
81-
Technical | 10 | Updates to code or processes that alter the technical content of the document
79+
New topic | 30 | New topic submissions for content that has never existed in DevDocs, such as tutorials, references, instructions, and other relevant content
80+
Major update | 20 | Significant updates to existing content
81+
Technical | 10 | Updates to code or processes that alter the technical content of the document, such as code snippets, reference documentation, parameter names and values, and other relevant content
8282

83+
If the PR earns recognition for significant updates and additions to the documentation, it may also receive a Special Achievement label, which garners an additional 20 points.

_includes/mftf/mftf_data.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{% assign mftf = site.data.mftf | group_by: "module" | sort: "name" %}

guides/v2.2/contributor-guide/contributing.md

Lines changed: 119 additions & 77 deletions
Large diffs are not rendered by default.

guides/v2.2/extension-dev-guide/build/component-registration.md

Lines changed: 52 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,58 +11,94 @@ Each component must have a file called `registration.php` in its root directory.
1111

1212
Register modules with:
1313

14-
ComponentRegistrar::register(ComponentRegistrar::MODULE, '<VendorName_ModuleName>', __DIR__);
14+
```php
15+
ComponentRegistrar::register(ComponentRegistrar::MODULE, '<VendorName_ModuleName>', __DIR__);
16+
```
1517

1618
Here `<VendorName>` is the name of the company providing the [module](https://glossary.magento.com/module) and `<ModuleName>` is the name of the module.
1719

1820
Avoid using "Ui" for your custom module name because the <code>%Vendor%_Ui</code> notation, required when specifying paths, might cause issues.
1921

2022
### Example
21-
use Magento\Framework\Component\ComponentRegistrar;
22-
ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Magento_AdminNotification', __DIR__);
23+
24+
```php
25+
use \Magento\Framework\Component\ComponentRegistrar;
26+
27+
ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Magento_AdminNotification', __DIR__);
28+
```
2329

2430
## Register themes {#register-themes}
2531

2632
Register themes with:
2733

28-
ComponentRegistrar::register(ComponentRegistrar::THEME, '<area>/<vendor>/<theme name>', __DIR__);
34+
```php
35+
ComponentRegistrar::register(ComponentRegistrar::THEME, '<area>/<vendor>/<theme name>', __DIR__);
36+
```
2937

3038
Here `<area>` is the functional area of the module (frontend, controller, and so on.), `<vendor>` is the name of the company providing the theme, and `<theme name>` is the name of the [theme](https://glossary.magento.com/theme).
3139

3240
### Example
33-
ComponentRegistrar::register(ComponentRegistrar::THEME, 'frontend/Magento/luma', __DIR__);
3441

35-
## Register language packages {#register-lagpacks}
42+
```php
43+
use \Magento\Framework\Component\ComponentRegistrar;
44+
45+
ComponentRegistrar::register(ComponentRegistrar::THEME, 'frontend/Magento/luma', __DIR__);
46+
```
47+
48+
## Register language packages {#register-langpacks}
3649

3750
Register language packages with:
3851

39-
ComponentRegistrar::register(ComponentRegistrar::LANGUAGE, '<VendorName>_<packageName>', __DIR__);
52+
```php
53+
ComponentRegistrar::register(ComponentRegistrar::LANGUAGE, '<VendorName>_<packageName>', __DIR__);
54+
```
4055

4156
Here `<VendorName>` is the name of the company providing the package and `<packageName>` is the name of the package.
4257

4358
### Example
44-
ComponentRegistrar::register(ComponentRegistrar::LANGUAGE, 'magento_de_de', __DIR__);
59+
60+
```php
61+
use \Magento\Framework\Component\ComponentRegistrar;
62+
63+
ComponentRegistrar::register(ComponentRegistrar::LANGUAGE, 'magento_de_de', __DIR__);
64+
```
65+
66+
## Register libraries {#register-libraries}
67+
68+
Libraries should be registered using
69+
70+
```php
71+
ComponentRegistrar::register(ComponentRegistrar::LIBRARY, '<vendor>/<library_name>', __DIR__);
72+
```
73+
74+
Here `<vendor>` is the name of the company providing the library. `<library_name>` is the library name.
75+
76+
### Example
77+
78+
```php
79+
use \Magento\Framework\Component\ComponentRegistrar;
80+
81+
ComponentRegistrar::register(ComponentRegistrar::LIBRARY, 'magento/framework', __DIR__);
82+
```
4583

4684
## Invoke `registration.php` in `composer.json` with autoload {#register-autoload}
4785

4886
After you create your `registration.php` file and you are creating [your component's composer.json file]({{page.baseurl}}/extension-dev-guide/build/composer-integration.html), invoke your `registration.php` file in the `autoload` section of `composer.json`:
4987

5088
```json
5189
{
52-
"name": "Acme-vendor/bar-component",
53-
"autoload": {
54-
"psr-4": { "AcmeVendor\\BarComponent\\": "" },
55-
"files": [ "registration.php" ]
56-
}
90+
"name": "Acme-vendor/bar-component",
91+
"autoload": {
92+
"psr-4": { "AcmeVendor\\BarComponent\\": "" },
93+
"files": [ "registration.php" ]
94+
}
5795
}
5896
```
5997

6098
### Sample `registration.php` file {#register-sample}
6199

62100
```php
63-
<?php
64-
65-
use Magento\Framework\Component\ComponentRegistrar;
101+
use \Magento\Framework\Component\ComponentRegistrar;
66102

67103
ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Magento_AdminNotification', __DIR__);
68104
```

guides/v2.2/mtf/mtf_installation.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ group: functional-testing-framework-guide
33
title: Installation of the Functional Testing Framework Entities
44
---
55

6+
{: .bs-callout-info}
7+
The Magento Testing Framework (MTF) is superseded by the Magento Functional Testing Framework ([MFTF][]).
8+
While the MTF is still functional, all MTF tests are ported over to the MFTF. We recommend using the MFTF for testing.
9+
610
Well, you are on the way to install the Functional Testing Framework!
711

812
## Check pre-installation conditions {#mtf_install_pre}
@@ -15,7 +19,7 @@ To install the Magento application, see [Magento Installation Guide][].
1519

1620
#### PHP {#mtf_install_pre_tools_php}
1721

18-
For more details about PHP verification, installation and configuration ([Ubuntu][], [CentOS][]).
22+
For more details about PHP verification, installation and configuration see [PHP Settings][].
1923

2024
{: .bs-callout .bs-callout-warning }
2125
In `php.ini` file, make sure `extension=php_openssl.dll` is not commented out.
@@ -75,18 +79,18 @@ ls
7579
Open `<magento2_root_dir>/dev/tests/functional/vendor/magento/mtf/CHANGELOG.md`.
7680
The latest version in `CHANGELOG.md` is version of the FTF you installed.
7781

78-
## Next Steps {#mtf_install_next}
82+
## Next steps {#mtf_install_next}
7983

8084
[Adjust the FTF configuration ]({{ page.baseurl }}/mtf/mtf_quickstart/mtf_quickstart_config.html)
8185

8286
<!-- Link defifnitions -->
8387

8488
[Adjust the FTF configuration ]: {{ page.baseurl }}/mtf/mtf_quickstart/mtf_quickstart_config.html
85-
[CentOS]: {{ page.baseurl }}/install-gde/prereq/php-centos.html
8689
[Composer]: https://getcomposer.org
8790
[globally]: https://getcomposer.org/doc/00-intro.md#globally
8891
[Install Composer]: {{ page.baseurl }}/install-gde/prereq/dev_install.html#instgde-prereq-compose-install
8992
[Magento Installation Guide]: {{ page.baseurl }}/install-gde/bk-install-guide.html
9093
[Open a command prompt]: {{ page.baseurl }}/install-gde/basics/basics_login.html
9194
[the Magento file system owner]: {{ page.baseurl }}/install-gde/prereq/apache-user.html
92-
[Ubuntu]: {{ page.baseurl }}/install-gde/prereq/php-ubuntu.html
95+
[PHP Settings]: {{ page.baseurl }}/install-gde/prereq/php-settings.html
96+
[MFTF]: https://devdocs.magento.com/mftf/docs/introduction.html

guides/v2.2/mtf/mtf_introduction.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ title: Introduction to the Functional Testing Framework
44
landing-page: Functional Testing Framework Guide
55
---
66

7+
{: .bs-callout-info}
8+
The Magento Testing Framework (MTF) is superseded by the Magento Functional Testing Framework ([MFTF][]).
9+
While the MTF is still functional, all MTF tests are being ported over to the MFTF. We recommend using the MFTF for testing.
10+
711
This guide provides instructions on installing and configuring the Functional Testing Framework (FTF). Using the FTF, you can create and run *functional* tests to make it easier to perform basic acceptance testing, smoke testing, regression testing, and so on.
812

913
FTF is an open source cross-platform solution (that is, does not depend on a specific operating system).
@@ -83,6 +87,6 @@ For other tests please see the following topics:
8387
Follow the FTF project and contribute on GitHub
8488
<https://github.com/magento/mtf>.
8589

86-
8790
[Selenium Standalone Server]: http://www.seleniumhq.org/download/
8891
[PHPUnit]: https://phpunit.de/
92+
[MFTF]: https://devdocs.magento.com/mftf/docs/introduction.html

guides/v2.2/mtf/mtf_quickstart.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ group: functional-testing-framework-guide
33
title: Quick start with the Functional Testing Framework
44
---
55

6+
{: .bs-callout-info}
7+
The Magento Testing Framework (MTF) is superseded by the Magento Functional Testing Framework ([MFTF][]).
8+
While the MTF is still functional, all MTF tests are being ported over to the MFTF. We recommend using the MFTF for testing.
9+
610
In this chapter you will learn how to:
711

812
- [Adjust configuration to set PHPUnit, the FTF, and credentials for Magento modules if required]({{ page.baseurl }}/mtf/mtf_quickstart/mtf_quickstart_config.html)
@@ -16,3 +20,5 @@ In this chapter you will learn how to:
1620
- [Check logs for failed tests]({{ page.baseurl }}/mtf/mtf_quickstart/mtf_quickstart_logs.html)
1721
- Check FTF logs
1822
- Check Magento logs
23+
24+
[MFTF]: https://devdocs.magento.com/mftf/docs/introduction.html

guides/v2.2/mtf/mtf_update.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ group: functional-testing-framework-guide
33
title: Update the Functional Testing Framework
44
---
55

6+
{: .bs-callout-info}
7+
The Magento Testing Framework (MTF) is superseded by the Magento Functional Testing Framework ([MFTF][]).
8+
While the MTF is still functional, all MTF tests are being ported over to the MFTF. We recommend using the MFTF for testing.
9+
610
Two types of updates are available.
711

812
- [Install a new version of the Functional Testing Framework](#mtf_update_install)
@@ -38,3 +42,5 @@ cd <magento2_root_dir>/dev/tests/functional/
3842
```bash
3943
composer update
4044
```
45+
46+
[MFTF]: https://devdocs.magento.com/mftf/docs/introduction.html

0 commit comments

Comments
 (0)