Skip to content

Commit 766efcc

Browse files
doboothdobooth
committed
Fixing links and other changes per review.
1 parent 4fc3430 commit 766efcc

25 files changed

+95
-95
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Each Magento source file included in this distribution is licensed under AGPL 3.
6969
See the license [here][] or contact [license@magentocommerce.com][] for a copy.
7070

7171
<!-- Link Definitions -->
72-
[Getting Started]: https://devdocs.magento.com/mftf/getting-started.html
72+
[Getting Started]: docs/getting-started.md
7373
[Contribution Guidelines]: .github/CONTRIBUTING.html
7474
[DevDocs Contributing]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md
7575
[security@magento.com]: mailto:security@magento.com

‎docs/commands/codeception.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,27 @@ To run the Codeception testing framework commands directly, change your director
1212
Run all the generated tests:
1313

1414
```bash
15-
../../../vendor/bin/codecept run functional -c dev/tests/acceptance/codeception.yml
15+
vendor/bin/codecept run functional -c dev/tests/acceptance/codeception.yml
1616
```
1717

1818
Run all tests without the `<group value="skip"/>` [annotation][]:
1919

2020
```bash
21-
../../../vendor/bin/codecept run functional --skip-group skip -c dev/tests/acceptance/codeception.yml
21+
vendor/bin/codecept run functional --skip-group skip -c dev/tests/acceptance/codeception.yml
2222
```
2323

2424
Run all tests with the `<group value="example"/>` [annotation][] but with no `<group value="skpip"/>`:
2525

2626
```bash
27-
../../../vendor/bin/codecept run functional --group example --skip-group skip -c dev/tests/acceptance/codeception.yml
27+
vendor/bin/codecept run functional --group example --skip-group skip -c dev/tests/acceptance/codeception.yml
2828
```
2929

3030
## `codecept run`
3131

3232
`codecept run` runs the test suites:
3333

3434
```bash
35-
../../../vendor/bin/codecept run
35+
vendor/bin/codecept run
3636
```
3737

3838
<div class="bs-callout bs-callout-info">
@@ -81,5 +81,5 @@ Options:
8181

8282
<!-- Link definitions -->
8383

84-
[mftf tool]: mftf.html
85-
[annotation]: ../test/annotations.html
84+
[mftf tool]: mftf.md
85+
[annotation]: ../test/annotations.md

‎docs/commands/mftf.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -384,11 +384,11 @@ vendor/bin/mftf upgrade:tests /Users/user/magento2/app/code/Magento/Catalog/Test
384384

385385
<!-- LINK DEFINITIONS -->
386386

387-
[configuration]: ../configuration.html
387+
[configuration]: ../configuration.md
388388
[Reference]: #reference
389389
[build]: #buildproject
390390
[setup]: #setupenv
391-
[Reporting]: ../reporting.html
391+
[Reporting]: ../reporting.md
392392

393393
<!-- Abbreviations -->
394394

‎docs/configuration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Example:
160160
MAGENTO_RESTAPI_SERVER_PORT=5000
161161
```
162162

163-
### *_BP
163+
### \*_BP
164164

165165
Settings to override base paths for the framework.
166166
You can use it when the MFTF is applied as a separate tool.
@@ -254,6 +254,6 @@ BROWSER=firefox
254254
<!-- Link definitions -->
255255

256256
[`MAGENTO_CLI_COMMAND_PATH`]: #magento_cli_command_path
257-
[generateDate]: test/actions.html#generatedate
258-
[mftf]: commands/mftf.html
257+
[generateDate]: test/actions.md#generatedate
258+
[mftf]: commands/mftf.md
259259
[timezones]: http://php.net/manual/en/timezones.php

‎docs/credentials.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ The decrypted values are only available in the `.credentials` file.
9494
The MFTF tests delivered with Magento application do not use credentials and do not cover external services, because of sensitivity of the data.</div>
9595

9696
<!-- Link definitions -->
97-
[`fillField`]: test/actions.html#fillfield
98-
[data]: data.html
99-
[initial setup]: getting-started.html
100-
[test reports]: reporting.html
97+
[`fillField`]: test/actions.md#fillfield
98+
[data]: data.md
99+
[initial setup]: getting-started.md
100+
[test reports]: reporting.md

‎docs/data.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ This emphasizes the practice for the `stepKey` of `createData` to be descriptive
7474

7575
## Use data returned by test actions
7676

77-
A test can also reference data that was returned as a result of [test actions](./test/actions.html#actions-returning-a-variable), like the action `<grabValueFrom selector="someSelector" stepKey="grabStepKey>`.
77+
A test can also reference data that was returned as a result of [test actions](./test/actions.md#actions-returning-a-variable), like the action `<grabValueFrom selector="someSelector" stepKey="grabStepKey>`.
7878

7979
Further in the test, the data grabbed by the `someSelector` selector can be referenced using the `stepKey` value. In this case, it is `grabStepKey`.
8080

@@ -89,7 +89,7 @@ The following example shows the usage of `grabValueFrom` in testing, where the r
8989

9090
The data to operate against can be included as literals in a test. Hard-coded data input can be useful in assertions.
9191

92-
See also [Actions](./test/actions.html).
92+
See also [Actions](./test/actions.md).
9393

9494
```xml
9595
userInput="We'll email you an order confirmation with details and tracking info."

‎docs/extending.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ __Use case__: Create an entity named `DivPanelGreen`, which is similar to the `D
363363
```
364364

365365
<!-- Link definitions -->
366-
[test]: ./test.html
367-
[data]: ./data.html
368-
[action group]: ./test/action-groups.html
369-
[actions]: ./test/actions.html
366+
[test]: ./test.md
367+
[data]: ./data.md
368+
[action group]: ./test/action-groups.md
369+
[actions]: ./test/actions.md

‎docs/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ cd dev/tests/acceptance
183183
```
184184

185185
```bash
186-
../../../vendor/bin/codecept run functional
186+
vendor/bin/codecept run functional -c dev/tests/acceptance/codeception.yml
187187
```
188188

189189
See more commands in [`codecept`][].

‎docs/introduction.md

-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
[Find your MFTF version][] of the MFTF.
44

5-
The latest Magento 2.3 release supports MFTF 2.3.13.
6-
The latest Magento 2.2 release supports MFTF 2.3.8.
7-
85
The Magento Functional Testing Framework (MFTF) aims to replace the [Functional Testing Framework] in future releases.
96
MFTF improves:
107

‎docs/merge_points/introduction.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ Consult [when to use Extends][] to use extends when deciding whether to merge or
2828
- [Extend Tests][]
2929

3030
<!-- Link definitions -->
31-
[when to use Extends]: https://devdocs.magento.com/mftf/docs/best-practices.html#when-to-use-extends
32-
[Merge Action Groups]: https://devdocs.magento.com/mftf/docs/merge_points/merge-action-groups.html
33-
[Merge Data]: https://devdocs.magento.com/mftf/docs/merge_points/merge-data.html
34-
[Merge Pages]: https://devdocs.magento.com/mftf/docs/merge_points/merge-pages.html
35-
[Merge Sections]: https://devdocs.magento.com/mftf/docs/merge_points/merge-sections.html
36-
[Merge Tests]: https://devdocs.magento.com/mftf/docs/merge_points/merge-tests.html
37-
[Extend Action Groups]: https://devdocs.magento.com/mftf/docs/merge_points/extend-action-groups.html
38-
[Extend Data]: https://devdocs.magento.com/mftf/docs/merge_points/extend-data.html
39-
[Extend Tests]: https://devdocs.magento.com/mftf/docs/merge_points/extend-tests.html
31+
[when to use Extends]: ../best-practices.md#when-to-use-extends
32+
[Merge Action Groups]: merge-action-groups.md
33+
[Merge Data]: merge-data.md
34+
[Merge Pages]: merge-pages.md
35+
[Merge Sections]: merge-sections.md
36+
[Merge Tests]: merge-tests.md
37+
[Extend Action Groups]: extend-action-groups.md
38+
[Extend Data]: extend-data.md
39+
[Extend Tests]: extend-tests.md

‎docs/merge_points/merge-action-groups.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ In this example we add a `<click>` command to check the checkbox that our extens
77

88
## Starting test
99

10+
<!-- raw -->
11+
1012
```xml
1113
<actionGroup name="FillAdminSimpleProductForm">
1214
<arguments>
@@ -71,4 +73,5 @@ In this example we add a `<click>` command to check the checkbox that our extens
7173
<click selector="{{AdminProductSEOSection.sectionHeader}}" stepKey="openSeoSectionAssert"/>
7274
<seeInField userInput="{{simpleProduct.urlKey}}" selector="{{AdminProductSEOSection.urlKeyInput}}" stepKey="assertFieldUrlKey"/>
7375
</actionGroup>
74-
```
76+
```
77+
<!-- endraw -->

‎docs/merging.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -562,10 +562,10 @@ The `_defaultSample` results corresponds to:
562562

563563
<!-- Link definitions -->
564564

565-
[`codecept`]: ./commands/codeception.html
566-
[`mftf`]: ./commands/mftf.html
567-
[`<data>`]: ./data.html
568-
[elements]: ./section.html#element-tag
569-
[`<pages>`]: ./page.html
570-
[`<sections>`]: ./section.html
571-
[`<tests>`]: ./test.html
565+
[`codecept`]: ./commands/codeception.md
566+
[`mftf`]: ./commands/mftf.md
567+
[`<data>`]: ./data.md
568+
[elements]: ./section.md#element-tag
569+
[`<pages>`]: ./page.md
570+
[`<sections>`]: ./section.md
571+
[`<tests>`]: ./test.md

‎docs/metadata.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -554,30 +554,30 @@ Example:
554554

555555
<!-- LINK DEFINITIONS -->
556556

557-
[actions]: test/actions.html
557+
[actions]: test/actions.md
558558
[api reference]: https://devdocs.magento.com/guides/v2.3/get-started/bk-get-started-api.html
559559
[application/x-www-form-urlencoded]: https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1
560560
{:target="_blank"}
561561
[catalogCategoryRepositoryV1 image]: img/catalogCategoryRepository-operations.png
562562
[catalogCategoryRepositoryV1SavePostBody]: #catalogCategoryRepositoryV1SavePostBody
563563
[contentType]: #contentType-tag
564564
[Create a new category]: #create-object-as-adminOauth
565-
[createData]: test/actions.html#createdata
565+
[createData]: test/actions.md#createdata
566566
[delete a category by its ID]: #delete-object-as-adminOauth
567-
[deleteData]: test/actions.html#deletedata
568-
[entity]: data.html#entity-tag
567+
[deleteData]: test/actions.md#deletedata
568+
[entity]: data.md#entity-tag
569569
[get information about a category by its ID]: #get-object-as-adminOauth
570-
[getData]: test/actions.html#getdata
570+
[getData]: test/actions.md#getdata
571571
[HTML forms]: https://www.w3.org/TR/html401/interact/forms.html
572-
{:target="_blank"}
572+
{:target="\_blank"}
573573
[oauth]: https://devdocs.magento.com/guides/v2.3/get-started/authentication/gs-authentication-oauth.html
574-
{:target="_blank"}
574+
{:target="\_blank"}
575575
[operation]: #operation-tag
576576
[reference]: #reference
577577
[rest request]: #handling-with-api
578578
[html form]: #using-html-forms
579579
[update category data by its ID]: #update-object-as-adminOauth
580-
[updateData]: test/actions.html#updatedata
580+
[updateData]: test/actions.md#updatedata
581581
[rest response]: #rest-response
582582

583583
*[CRUD]: Create Read Update Delete

‎docs/page.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,12 @@ Attributes|Type|Use|Description
161161
`remove`|boolean|optional|The default value is `"false"`. Set to `"true"` to remove this element during parsing.
162162

163163
<!-- Link definitions -->
164-
[`<createData>`]: test/actions.html#createdata
164+
[`<createData>`]: test/actions.md#createdata
165165
[`<page>`]: #page-tag
166166
[`<section>`]: #section-tag
167-
[`<test>`]: test.html
168-
[actions]: test/actions.html
167+
[`<test>`]: test.md
168+
[actions]: test/actions.md
169169
[explicit page]: #explicit-page
170170
[PageObjects]: https://github.com/SeleniumHQ/selenium/wiki/PageObjects
171171
[parameterized page]: #parameterized-page
172-
[section]: section.html
172+
[section]: section.md

‎docs/reporting.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -344,13 +344,13 @@ Refer to the [Reporting section][] for more Allure CLI details.
344344

345345
<!-- Link definitions -->
346346

347-
[`after`]: test.html#after-tag
348-
[`run:group`]: commands/mftf.html#rungroup
349-
[`run:test`]: commands/mftf.html#runtest
347+
[`after`]: test.md#after-tag
348+
[`run:group`]: commands/mftf.md#rungroup
349+
[`run:test`]: commands/mftf.md#runtest
350350
[Allure Framework]: https://docs.qameta.io/allure/
351351
[Allure Test Report]: http://allure.qatools.ru/
352-
[codecept]: commands/codeception.html
352+
[codecept]: commands/codeception.md
353353
[codeception]: https://codeception.com/docs/reference/Commands
354-
[mftf]: commands/mftf.html
354+
[mftf]: commands/mftf.md
355355
[report an issue]: https://github.com/magento/magento2-functional-testing-framework/blob/master/.github/CONTRIBUTING.md#report-an-issue
356356
[Reporting section]: https://docs.qameta.io/allure/#_reporting

‎docs/section/locator-functions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,5 @@ Given the above element definitions, you call the elements in a test just like a
4242

4343
<!-- Link Definitions -->
4444
[Locator functions]: http://codeception.com/docs/reference/Locator
45-
[section]: ../section.html
46-
[parameterized selectors]: ./parameterized-selectors.html
45+
[section]: ../section.md
46+
[parameterized selectors]: ./parameterized-selectors.md

‎docs/section/parameterized-selectors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,4 +152,4 @@ Any data can be used in parameterized elements, as well as entered in test actio
152152
* `{$variable}` is a reference to data returned by a test action, like `<grabValueFrom>`.
153153

154154
<!-- Link Definitions -->
155-
[test]: ../test.html
155+
[test]: ../test.md

‎docs/suite.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -282,12 +282,12 @@ Attributes|Type|Use|Description
282282
`remove`|boolean|optional|Removing the filter during merging.
283283

284284
<!-- Link definitions -->
285-
[actions]: test/actions.html
286-
[action groups]: test/action-groups.html
285+
[actions]: test/actions.md
286+
[action groups]: test/action-groups.md
287287
[`<after>`]: #after-tag
288288
[`<before>`]: #before-tag
289-
[`generate:tests`]: commands/mftf.html#generatetests
290-
[test]: test.html
289+
[`generate:tests`]: commands/mftf.md#generatetests
290+
[test]: test.md
291291
[`<test>`]: #test-tag
292292
[`<group>`]: #group-tag
293293
[`<module>`]: #module-tag

‎docs/test.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -136,12 +136,12 @@ See [Action groups][action group] for more information.
136136
[`<before>`]: #before-tag
137137
[`<test>`]: #test-tag
138138
[`<tests>`]: #tests-tag
139-
[action group]: ./test/action-groups.html
140-
[actions]: ./test/actions.html
139+
[action group]: ./test/action-groups.md
140+
[actions]: ./test/actions.md
141141
[Allure]: https://github.com/allure-framework/
142-
[Annotations]: ./test/annotations.html
143-
[assertion]: ./test/assertions.html
142+
[Annotations]: ./test/annotations.md
143+
[assertion]: ./test/assertions.md
144144
[Codeception]: https://codeception.com/docs/07-AdvancedUsage
145-
[extend]: extending.html
146-
[merging]: ./merging.html#insert-after
147-
[suites]: ./suite.html
145+
[extend]: extending.md
146+
[merging]: ./merging.md#insert-after
147+
[suites]: ./suite.md

‎docs/test/action-groups.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ Attribute|Type|Use|Description
258258
`type`|Possible values: `string`, `entity` (default).|optional|Defines the argument data type; Defaults to `entity`.
259259

260260
<!-- Link Definitions -->
261-
[actions]: ./actions.html
262-
[test]: ../test.html
261+
[actions]: ./actions.md
262+
[test]: ../test.md
263263
[`argument`]: #argument-tag
264-
[created]: ../data.html#persist-data
264+
[created]: ../data.md#persist-data

0 commit comments

Comments
 (0)