Skip to content

Commit b7dd56b

Browse files
committed
Fixing links and HTML.
1 parent 70fe5a7 commit b7dd56b

14 files changed

+57
-47
lines changed

docs/commands/codeception.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# CLI commands: vendor/bin/codecept
22

3-
4-
<div class="bs-callout bs-callout-warning">
3+
<div class="bs-callout bs-callout-warning" markdown="1">
54
We do not recommend using Codeception commands directly as they can break the MFTF basic workflow.
6-
All the Codeception commands you need are wrapped using the [`mftf` tool][].</div>
5+
All the Codeception commands you need are wrapped using the [`mftf` tool][].
76

87
To run the Codeception testing framework commands directly, change your directory to the `<Magento root>`.
8+
</div>
99

1010
## Usage examples
1111

@@ -35,7 +35,7 @@ vendor/bin/codecept run functional --group example --skip-group skip
3535
vendor/bin/codecept run
3636
```
3737

38-
<div class="bs-callout .bs-callout-info">
38+
<div class="bs-callout bs-callout-info">
3939
The following documentation corresponds to Codeception 2.3.8.
4040
</div>
4141

docs/configuration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Example:
1818
MAGENTO_BASE_URL=http://magento2.vagrant251
1919
```
2020

21-
<div class=".bs-callout .bs-callout-info">
21+
<div class="bs-callout bs-callout-info" markdown="1">
2222
If the `MAGENTO_BASE_URL` contains a subdirectory (like `http://magento.test/magento2ce`), specify [`MAGENTO_CLI_COMMAND_PATH`][].
2323
</div>
2424

@@ -86,7 +86,7 @@ SELENIUM_PROTOCOL=http
8686
SELENIUM_PATH=/wd/hub
8787
```
8888

89-
<div class=".bs-callout .bs-callout-warning">
89+
<div class="bs-callout bs-callout-warning" markdown="1">
9090
`SELENIUM_*` values are required if you are running Selenium on an external system.
9191
If you change the configuration of the external Selenium server, you must update these values.
9292
</div>

docs/credentials.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,9 @@ carriers_usps_password=Lmgxvrq89uPwECeV
4949
....
5050
```
5151

52-
{: .bs-callout .bs-callout-info }
52+
<div class="bs-callout bs-callout-info" markdown="1">
5353
The `/` symbol is not supported in a key name.
54+
</div>
5455

5556
You are free to use any other keys you like, as they are merely the keys to reference from your tests.
5657

@@ -89,7 +90,7 @@ The MFTF dynamically retrieves, encrypts, and decrypts the sensitive data during
8990
Decrypted credentials do not appear in the console, error logs, or [test reports][].
9091
The decrypted values are only available in the `.credentials` file.
9192

92-
<div class=".bs-callout .bs-callout-info">
93+
<div class="bs-callout bs-callout-info">
9394
The MFTF tests delivered with Magento application do not use credentials and do not cover external services, because of sensitivity of the data.</div>
9495

9596
<!-- Link definitions -->

docs/extending.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ You can create or update any component of the parent body in your new test/actio
1111

1212
Specify needed variations for a parent object and produce a copy of the original that incorporates the specified changes (the "delta").
1313

14+
<div class="bs-callout bs-callout-info">
1415
Unlike merging, the parent test (or action group) will still exist after the test generation.
15-
{:.bs-callout .bs-callout-info}
16+
</div>
1617

1718
## Extending tests
1819

docs/getting-started.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Getting started
22

3-
<div class="bs-callout bs-callout-info">
4-
<a href="https://devdocs.magento.com/mftf/introduction.html#find-version">Find out your version</a> of the MFTF.
5-
3+
<div class="bs-callout bs-callout-info" markdown="1">
4+
[Find your MFTF version][] of the MFTF.
65
The latest Magento 2.3 release supports MFTF 2.3.13.
76
The latest Magento 2.2 release supports MFTF 2.3.8.
87
</div>
@@ -16,9 +15,9 @@ Make sure that you have the following software installed and configured on your
1615
- [Java 1.8 or later][java]
1716
- [Selenium Server Standalone 3.6 or later][selenium server] and [ChromeDriver 2.33 or later][chrome driver] or other webdriver in the same directory
1817

19-
{:.bs-callout .bs-callout-tip}
18+
<div class="bs-callout bs-callout-tip" markdown="1">
2019
[PhpStorm] supports [Codeception test execution][], which is helpful when debugging.
21-
20+
</div>
2221
## Install Magento {#install-magento}
2322

2423
Use instructions below to install Magento.
@@ -68,7 +67,7 @@ To disable the WYSIWYG and enable the web driver to process these fields as simp
6867
3. In the WYSIWYG Options section set the **Enable WYSIWYG Editor** option to **Disabled Completely**.
6968
4. Click **Save Config**.
7069

71-
<div class=".bs-callout .bs-callout-tip">
70+
<div class="bs-callout bs-callout-tip">
7271
When you want to test the WYSIWYG functionality, re-enable WYSIWYG in your test suite.
7372
</div>
7473

@@ -115,7 +114,7 @@ vendor/bin/mftf generate:urn-catalog --force .idea/
115114

116115
See [`generate:urn-catalog`][] for more details.'
117116

118-
<div class=".bs-callout .bs-callout-tip">
117+
<div class="bs-callout bs-callout-tip" markdown="1">
119118
You can simplify command entry by adding the absolute path to the `vendor/bin` directory path to your PATH environment variable.
120119
After adding the path, you can run `mftf` without having to include `vendor/bin`.
121120
</div>
@@ -142,8 +141,9 @@ Specify the following parameters, which are required to launch tests:
142141
- `MAGENTO_ADMIN_PASSWORD` must contain the user password required for authorization in the Admin area.
143142
Example: `MAGENTO_ADMIN_PASSWORD=123123q`
144143

145-
{: .bs-callout .bs-callout-info }
144+
<div class="bs-callout bs-callout-info" markdown="1">
146145
If the `MAGENTO_BASE_URL` contains a subdirectory like `http://magento.test/magento2ce`, specify `MAGENTO_CLI_COMMAND_PATH`.
146+
</div>
147147

148148
Learn more about environmental settings in [Configuration][].
149149

@@ -300,8 +300,9 @@ allure serve dev/tests/_output/allure-results/
300300
[install Allure]: https://github.com/allure-framework/allure2#download
301301
[java]: http://www.oracle.com/technetwork/java/javase/downloads/index.html
302302
[mftf tests]: introduction.md#mftf-tests
303-
[php]: https://devdocs.magento.com/guides/2.3/install-gde/system-requirements-tech.md#php
303+
[php]: https://devdocs.magento.com/guides/v2.3/install-gde/system-requirements-tech.md#php
304304
[PhpStorm]: https://www.jetbrains.com/phpstorm/
305305
[selenium server]: https://www.seleniumhq.org/download/
306306
[Set up a standalone MFTF]: #set-up-a-standalone-mftf
307307
[test suite]: suite.md
308+
[Find your MFTF version]: introduction.md#find-your-mftf-version

docs/introduction.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Introduction to the Magento Functional Testing Framework version 2.3
1+
# Introduction to the Magento Functional Testing Framework
22

3-
<a href="https://devdocs.magento.com/mftf/introduction.html#find-version">Find out your version</a> of the MFTF.
3+
[Find your MFTF version][] of the MFTF.
44

55
The latest Magento 2.3 release supports MFTF 2.3.13.
66
The latest Magento 2.2 release supports MFTF 2.3.8.
@@ -15,9 +15,11 @@ MFTF improves:
1515
- **Maintainability** based on simple test creation and overall structure.
1616

1717
Because MFTF tests are written in XML, you no longer need to learn PHP to write tests.
18-
<div class=".bs-callout .bs-callout-info">
18+
19+
<div class="bs-callout bs-callout-info" markdown="1">
1920
We are actively developing functional tests.
2021
Refer to `<magento_root>/app/code/<vendor_name>/<module_name>/Test/Mftf/` for examples.
22+
Check out the [MFTF Test Migration][] repo.
2123
</div>
2224

2325
## Audience
@@ -46,7 +48,7 @@ As a Magento developer, test changes, such as extended search functionality, a n
4648

4749
As a software engineer, perform regression testing before release to ensure that Magento works as expected with new functionality.
4850

49-
## Find your MFTF version {#find-version}
51+
## Find your MFTF version
5052

5153
There are two options to find out your MFTF version:
5254

@@ -132,4 +134,6 @@ Follow the [MFTF project] and [contribute on Github].
132134
<!-- Link definitions -->
133135
[contribute on Github]: https://github.com/magento/magento2-functional-testing-framework/blob/master/.github/CONTRIBUTING.md
134136
[Functional Testing Framework]: https://devdocs.magento.com/guides/v2.3/mtf/mtf_introduction.html
135-
[MFTF project]: https://github.com/magento/magento2-functional-testing-framework
137+
[MFTF project]: https://github.com/magento/magento2-functional-testing-framework
138+
[Find your MFTF version]: #find-your-mftf-version
139+
[MFTF Test Migration]: https://github.com/magento/magento-functional-tests-migration

docs/reporting.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ Each time you run tests, the MFTF appends an XML file with results at the `tests
277277

278278
The official [Allure Test Report][] documentation is well-covered, so we'll list only the CLI commands that you would need for your day-to-day work.
279279

280-
<div class=".bs-callout .bs-callout-info">
280+
<div class="bs-callout bs-callout-info">
281281
The following commands are relative to the Magento installation directory.
282282
</div>
283283

@@ -299,7 +299,7 @@ To launch the generated report in a web browser:
299299
allure open dev/tests/acceptance/tests/_output/allure-report
300300
```
301301

302-
<div class="bs-callout bs-callout-info">
302+
<div class="bs-callout bs-callout-info" markdown="1">
303303
By default, Allure generates reports in the `allure-report/` at the current directory.
304304
For example, if you run the command without `-o` flag while you are in the `magento2/` directory, Allure will generate a report at the `magento2/allure-report/` directory.
305305
</div>

docs/section/parameterized-selectors.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Parameterized selectors
22

3-
43
Use the following examples to create and use parameterized selectors in the MFTF.
54

65
## Set up a selector in section
@@ -73,7 +72,7 @@ For the parameterized part of the selector, add `{{var1}}, {{var2}}, ..., {{varN
7372
</section>
7473
```
7574

76-
<div class="bs-callout .bs-callout-info">
75+
<div class="bs-callout bs-callout-info" markdown="1">
7776
There is no need to use sequential variables like `{{var1}}`, `{{var2}}`. Parameterized replacement reads variables and maps them to the test call of the element sequentially from left to right, meaning you can use a selector like `#element .{{categoryId}} .{{productId}}`."
7877
</div>
7978

docs/test.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Test cases in the Magento Functional Testing Framework (MFTF) are defined in XML
66
MFTF `<tests>` is considered a sequence of actions with associated parameters.
77
Any failed [assertion] within a test constitutes a failed test.
88

9-
<div class="bs-callout bs-callout-info">
9+
<div class="bs-callout bs-callout-info" markdown="1">
1010
`<before>` and `<after>` hooks are not global within `<tests>`.
1111
They only apply to the `<test>` in which they are declared.
1212
The steps in `<after>` are run in both successful **and** failed test runs.

docs/test/actions.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Test actions
22

3-
43
Actions in the MFTF allow you to automate different scenarios of Magento user's actions.
54
They are mostly XML implementations of [Codeception actions](http://codeception.com/docs/modules/WebDriver#Actions).
65
Some actions drive browser elements, while others use REST APIs.
@@ -153,7 +152,6 @@ The only difference is that different data is assigned to the attributes, which
153152
<!-- {% endraw %} -->
154153

155154
Here, [`<click>`](#click) performs a click on a button that can be found by the selector that is stored in the `signInAccountButton` of the `StorefrontCustomerSignInFormSection`.
156-
See the `StorefrontCustomerSignInPage.xml` file code in [step 2](#section-code).
157155

158156
## Actions returning a variable
159157

@@ -1349,7 +1347,7 @@ Note that the makeScreenshot action does not automatically add the screenshot to
13491347
<makeScreenshot userInput="example" stepKey="screenshotPage"/>
13501348
```
13511349

1352-
<div class=".bs-callout .bs-callout-info">
1350+
<div class="bs-callout bs-callout-info">
13531351
This action does not add a screenshot to the Allure [report](../reporting.md).</div>
13541352

13551353
### maximizeWindow
@@ -2474,7 +2472,7 @@ Attribute|Type|Use|Description
24742472

24752473
Wait for all Magento loading overlays to disappear.
24762474

2477-
<div class=".bs-callout .bs-callout-info">
2475+
<div class="bs-callout bs-callout-info">
24782476
The CSS class for loading masks is not used consistently throughout Magento.
24792477
Therefore, this convenience function tries to wait for various specific selectors.</div>
24802478

docs/test/annotations.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,13 @@ The `<group>` element is an implementation of a [`@group`] Codeception tag.
7777
Any test can be a part of multiple groups.
7878
The purpose of grouping is to create a set of test for a functionality or purpose, such as all cart tests or all slow tests and run them together locally.
7979

80-
{:.bs-callout .bs-callout-warning}
81-
Group values cannot collide with [suite] names.
80+
<div class="bs-callout bs-callout-warning" markdown="1">
81+
Group values cannot collide with [suite][] names.
82+
</div>
8283

83-
{:.bs-callout .bs-callout-tip}
84+
<div class="bs-callout bs-callout-tip" markdown="1">
8485
Add `<skip>` to the test to skip it during test run.
86+
</div>
8587

8688
Attribute|Type|Use|Definition
8789
---|---|---|---

docs/tips-tricks.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ In the bad example we see two parameters being passed into the selector with lit
1313

1414
**Why?** The next person maintaining the test or extending it may not be able to understand what the parameters are referencing.
1515

16-
<span stype="color:green">
16+
<span style="color:green">
1717
Good
1818
</span>
1919

@@ -54,7 +54,7 @@ In the bad example, we perform some heavy UI steps first.
5454

5555
**Why?** If something goes wrong there, then the critical `magentoCLI` commands may not get a chance to run, leaving Magento configured incorrectly for any upcoming tests.
5656

57-
<span stype="color:green">
57+
<span style="color:green">
5858
Good:
5959
</span>
6060

@@ -108,7 +108,7 @@ And for `seeElement` it will output something like this:
108108
There is a subtle distinction: The first is a failure but it is the desired result: a 'positive failure'.
109109
The second is a proper result of the action.
110110

111-
<span stype="color:green">
111+
<span style="color:green">
112112
Good:
113113
</span>
114114

@@ -128,7 +128,7 @@ Bad:
128128

129129
Whenever possible, specify a `defaultValue` for action group arguments.
130130

131-
<span stype="color:green">
131+
<span style="color:green">
132132
GOOD:
133133
</span>
134134

@@ -176,7 +176,7 @@ Build your tests using action groups, even if an action group contains a single
176176
Extending a single action group will update all tests that use this group.
177177
This improves maintainability as multiple instances of a failure can be fixed with a single action group update.
178178

179-
<span stype="color:green">
179+
<span style="color:green">
180180
GOOD:
181181
</span>
182182

@@ -234,7 +234,7 @@ Do not use numbers to make a `stepKey` unique.
234234

235235
**Why?** This helps with readability and clarity.
236236

237-
<span stype="color:green">
237+
<span style="color:green">
238238
GOOD:
239239
</span>
240240

@@ -308,7 +308,7 @@ Example:
308308
</div>
309309
```
310310

311-
<span stype="color:green">
311+
<span style="color:green">
312312
GOOD:
313313
</span>
314314

@@ -358,7 +358,7 @@ BAD:
358358
Use descriptive variable names to increase readability.
359359
**Why?** It makes the code easier to follow and update.
360360

361-
<span stype="color:green">
361+
<span style="color:green">
362362
GOOD:
363363
</span>
364364

@@ -379,7 +379,7 @@ BAD:
379379
When working with input type `checkbox`, do not use the `click` action; use `checkOption` or `uncheckOption` instead.
380380
**Why?** A click does not make it clear what the ending state will be; it will simply toggle the current state. Using the proper actions will ensure the expected state of the checkbox.
381381

382-
<span stype="color:green">
382+
<span style="color:green">
383383
GOOD:
384384
</span>
385385

docs/update.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Update the Magento Functional Testing Framework
22

3-
<div class="bs-callout bs-callout-info">
4-
<a href="https://devdocs.magento.com/mftf/introduction.html#find-version">Find out your version</a> of the MFTF.
3+
<div class="bs-callout bs-callout-info" markdown="1">
4+
[Find your version][] of the MFTF.
55

66
The latest Magento 2.3 release supports MFTF 2.3.13.
77
The latest Magento 2.2 release supports MFTF 2.3.8.
@@ -76,4 +76,5 @@ To update the MFTF from the previous minor version:
7676
<!-- Link Definitions -->
7777
[Changelog]: https://github.com/magento/magento2-functional-testing-framework/blob/master/CHANGELOG.md
7878
[WYSIWYG settings]: getting-started.md#wysiwyg-settings
79-
[Security settings]: getting-started.md#security-settings
79+
[Security settings]: getting-started.md#security-settings
80+
[Find your version]: introduction.md#find-your-mftf-version

docs/versioning.md

+3
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,15 @@ MFTF versioning policy follows [Semantic Versioning](https://semver.org/) guidel
2424

2525
Version numbering schemes help users to understand the scope of the changes made a new release.
2626

27+
```tree
2728
X.Y.Z
2829
| | |
2930
| | +-- Backward Compatible changes (Patch release - bug fixes, small additions)
3031
| +---- Backward Compatible changes (Minor release - small new features, bug fixes)
3132
+------ Backward Incompatible changes (Major release - new features and/or major changes)
3233
34+
```
35+
3336
For example:
3437

3538
- Magento 2 ships with MFTF version 2.3.9

0 commit comments

Comments
 (0)