Fixing links and HTML.

dobooth · dobooth · commit b7dd56b5d28c · 2019-03-08T12:04:16.000-06:00
diff --git a/docs/commands/codeception.md b/docs/commands/codeception.md
@@ -1,11 +1,11 @@
 # CLI commands: vendor/bin/codecept
 
-
-<div class="bs-callout bs-callout-warning">
+<div class="bs-callout bs-callout-warning" markdown="1">
 We do not recommend using Codeception commands directly as they can break the MFTF basic workflow.
-All the Codeception commands you need are wrapped using the [`mftf` tool][].</div>
+All the Codeception commands you need are wrapped using the [`mftf` tool][].
 
 To run the Codeception testing framework commands directly, change your directory to the `<Magento root>`.
+</div>
 
 ## Usage examples
 
@@ -35,7 +35,7 @@ vendor/bin/codecept run functional --group example --skip-group skip
 vendor/bin/codecept run
 ```
 
-<div class="bs-callout .bs-callout-info">
+<div class="bs-callout bs-callout-info">
 The following documentation corresponds to Codeception 2.3.8.
 </div>
 
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -18,7 +18,7 @@ Example:
 MAGENTO_BASE_URL=http://magento2.vagrant251
 ```
 
-<div class=".bs-callout .bs-callout-info">
+<div class="bs-callout bs-callout-info" markdown="1">
 If the `MAGENTO_BASE_URL` contains a subdirectory (like `http://magento.test/magento2ce`), specify [`MAGENTO_CLI_COMMAND_PATH`][].
 </div>
 
@@ -86,7 +86,7 @@ SELENIUM_PROTOCOL=http
 SELENIUM_PATH=/wd/hub
 ```
 
-<div class=".bs-callout .bs-callout-warning">
+<div class="bs-callout bs-callout-warning" markdown="1">
 `SELENIUM_*` values are required if you are running Selenium on an external system.
 If you change the configuration of the external Selenium server, you must update these values.
 </div>
diff --git a/docs/credentials.md b/docs/credentials.md
@@ -49,8 +49,9 @@ carriers_usps_password=Lmgxvrq89uPwECeV
 ....
 ```
 
-{: .bs-callout .bs-callout-info }
+<div class="bs-callout bs-callout-info" markdown="1">
 The `/` symbol is not supported in a key name.
+</div>
 
 You are free to use any other keys you like, as they are merely the keys to reference from your tests.
 
@@ -89,7 +90,7 @@ The MFTF dynamically retrieves, encrypts, and decrypts the sensitive data during
 Decrypted credentials do not appear in the console, error logs, or [test reports][].
 The decrypted values are only available in the `.credentials` file.
 
-<div class=".bs-callout .bs-callout-info">
+<div class="bs-callout bs-callout-info">
 The MFTF tests delivered with Magento application do not use credentials and do not cover external services, because of sensitivity of the data.</div>
 
 <!-- Link definitions -->
diff --git a/docs/extending.md b/docs/extending.md
@@ -11,8 +11,9 @@ You can create or update any component of the parent body in your new test/actio
 
 Specify needed variations for a parent object and produce a copy of the original that incorporates the specified changes (the "delta").
 
+<div class="bs-callout bs-callout-info">
 Unlike merging, the parent test (or action group) will still exist after the test generation.
- {:.bs-callout .bs-callout-info}
+</div>
 
 ## Extending tests
 
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,8 +1,7 @@
 # Getting started
 
-<div class="bs-callout bs-callout-info">
-<a href="https://devdocs.magento.com/mftf/introduction.html#find-version">Find out your version</a> of the MFTF.
-
+<div class="bs-callout bs-callout-info" markdown="1">
+[Find your MFTF version][] of the MFTF.
 The latest Magento 2.3 release supports MFTF 2.3.13.
 The latest Magento 2.2 release supports MFTF 2.3.8.
 </div>
@@ -16,9 +15,9 @@ Make sure that you have the following software installed and configured on your
 - [Java 1.8 or later][java]
 - [Selenium Server Standalone 3.6 or later][selenium server] and [ChromeDriver 2.33 or later][chrome driver] or other webdriver in the same directory
 
-{:.bs-callout .bs-callout-tip}
+<div class="bs-callout bs-callout-tip" markdown="1">
 [PhpStorm] supports [Codeception test execution][], which is helpful when debugging.
-
+</div>
 ## Install Magento {#install-magento}
 
 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
 3. In the WYSIWYG Options section set the **Enable WYSIWYG Editor** option to **Disabled Completely**.
 4. Click **Save Config**.
 
-<div class=".bs-callout .bs-callout-tip">
+<div class="bs-callout bs-callout-tip">
 When you want to test the WYSIWYG functionality, re-enable WYSIWYG in your test suite.
 </div>
 
@@ -115,7 +114,7 @@ vendor/bin/mftf generate:urn-catalog --force .idea/
 
 See [`generate:urn-catalog`][] for more details.'
 
-<div class=".bs-callout .bs-callout-tip">
+<div class="bs-callout bs-callout-tip" markdown="1">
 You can simplify command entry by adding the  absolute  path to the `vendor/bin` directory path to your PATH environment variable.
 After adding the path, you can run `mftf` without having to include `vendor/bin`.
 </div>
@@ -142,8 +141,9 @@ Specify the following parameters, which are required to launch tests:
 - `MAGENTO_ADMIN_PASSWORD` must contain the user password required for authorization in the Admin area.
   Example: `MAGENTO_ADMIN_PASSWORD=123123q`
 
-{: .bs-callout .bs-callout-info }
+<div class="bs-callout bs-callout-info" markdown="1">
 If the `MAGENTO_BASE_URL` contains a subdirectory like `http://magento.test/magento2ce`, specify `MAGENTO_CLI_COMMAND_PATH`.
+</div>
 
 Learn more about environmental settings in [Configuration][].
 
@@ -300,8 +300,9 @@ allure serve dev/tests/_output/allure-results/
 [install Allure]: https://github.com/allure-framework/allure2#download
 [java]: http://www.oracle.com/technetwork/java/javase/downloads/index.html
 [mftf tests]: introduction.md#mftf-tests
-[php]: https://devdocs.magento.com/guides/2.3/install-gde/system-requirements-tech.md#php
+[php]: https://devdocs.magento.com/guides/v2.3/install-gde/system-requirements-tech.md#php
 [PhpStorm]: https://www.jetbrains.com/phpstorm/
 [selenium server]: https://www.seleniumhq.org/download/
 [Set up a standalone MFTF]: #set-up-a-standalone-mftf
 [test suite]: suite.md
+[Find your MFTF version]: introduction.md#find-your-mftf-version
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -1,6 +1,6 @@
-# Introduction to the Magento Functional Testing Framework version 2.3
+# Introduction to the Magento Functional Testing Framework
 
-<a href="https://devdocs.magento.com/mftf/introduction.html#find-version">Find out your version</a> of the MFTF.
+[Find your MFTF version][] of the MFTF.
 
 The latest Magento 2.3 release supports MFTF 2.3.13.
 The latest Magento 2.2 release supports MFTF 2.3.8.
@@ -15,9 +15,11 @@ MFTF improves:
 - **Maintainability** based on simple test creation and overall structure.
 
 Because MFTF tests are written in XML, you no longer need to learn PHP to write tests.
-<div class=".bs-callout .bs-callout-info">
+
+<div class="bs-callout bs-callout-info" markdown="1">
 We are actively developing functional tests.
 Refer to `<magento_root>/app/code/<vendor_name>/<module_name>/Test/Mftf/` for examples.
+Check out the [MFTF Test Migration][] repo.
 </div>
 
 ## Audience
@@ -46,7 +48,7 @@ As a Magento developer, test changes, such as extended search functionality, a n
 
 As a software engineer, perform regression testing before release to ensure that Magento works as expected with new functionality.
 
-## Find your MFTF version {#find-version}
+## Find your MFTF version
 
 There are two options to find out your MFTF version:
 
@@ -132,4 +134,6 @@ Follow the [MFTF project] and [contribute on Github].
 <!-- Link definitions -->
 [contribute on Github]: https://github.com/magento/magento2-functional-testing-framework/blob/master/.github/CONTRIBUTING.md
 [Functional Testing Framework]: https://devdocs.magento.com/guides/v2.3/mtf/mtf_introduction.html
-[MFTF project]: https://github.com/magento/magento2-functional-testing-framework
+[MFTF project]: https://github.com/magento/magento2-functional-testing-framework
+[Find your MFTF version]: #find-your-mftf-version
+[MFTF Test Migration]: https://github.com/magento/magento-functional-tests-migration
diff --git a/docs/reporting.md b/docs/reporting.md
@@ -277,7 +277,7 @@ Each time you run tests, the MFTF appends an XML file with results at the `tests
 
 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.
 
-<div class=".bs-callout .bs-callout-info">
+<div class="bs-callout bs-callout-info">
 The following commands are relative to the Magento installation directory.
 </div>
 
@@ -299,7 +299,7 @@ To launch the generated report in a web browser:
 allure open dev/tests/acceptance/tests/_output/allure-report
 ```
 
-<div class="bs-callout bs-callout-info">
+<div class="bs-callout bs-callout-info" markdown="1">
 By default, Allure generates reports in the `allure-report/` at the current directory.
 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.
 </div>
diff --git a/docs/section/parameterized-selectors.md b/docs/section/parameterized-selectors.md
@@ -1,6 +1,5 @@
 # Parameterized selectors
 
-
 Use the following examples to create and use parameterized selectors in the MFTF.
 
 ## Set up a selector in section
@@ -73,7 +72,7 @@ For the parameterized part of the selector, add `{{var1}}, {{var2}}, ..., {{varN
 </section>
 ```
 
-<div class="bs-callout .bs-callout-info">
+<div class="bs-callout bs-callout-info" markdown="1">
 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}}`."
 </div>
 
diff --git a/docs/test.md b/docs/test.md
@@ -6,7 +6,7 @@ Test cases in the Magento Functional Testing Framework (MFTF) are defined in XML
 MFTF `<tests>` is considered a sequence of actions with associated parameters.
 Any failed [assertion] within a test constitutes a failed test.
 
-<div class="bs-callout bs-callout-info">
+<div class="bs-callout bs-callout-info" markdown="1">
  `<before>` and `<after>` hooks are not global within `<tests>`.
 They only apply to the `<test>` in which they are declared.
 The steps in `<after>` are run in both successful **and** failed test runs.
diff --git a/docs/test/actions.md b/docs/test/actions.md
@@ -1,6 +1,5 @@
 # Test actions
 
-
 Actions in the MFTF allow you to automate different scenarios of Magento user's actions.
 They are mostly XML implementations of [Codeception actions](http://codeception.com/docs/modules/WebDriver#Actions).
 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
 <!-- {% endraw %} -->
 
 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`.
-See the `StorefrontCustomerSignInPage.xml` file code in [step 2](#section-code).
 
 ## Actions returning a variable
 
@@ -1349,7 +1347,7 @@ Note that the makeScreenshot action does not automatically add the screenshot to
 <makeScreenshot userInput="example" stepKey="screenshotPage"/>
 ```
 
-<div class=".bs-callout .bs-callout-info">
+<div class="bs-callout bs-callout-info">
 This action does not add a screenshot to the Allure [report](../reporting.md).</div>
 
 ### maximizeWindow
@@ -2474,7 +2472,7 @@ Attribute|Type|Use|Description
 
 Wait for all Magento loading overlays to disappear.
 
-<div class=".bs-callout .bs-callout-info">
+<div class="bs-callout bs-callout-info">
 The CSS class for loading masks is not used consistently throughout Magento.
 Therefore, this convenience function tries to wait for various specific selectors.</div>
 
diff --git a/docs/test/annotations.md b/docs/test/annotations.md
@@ -77,11 +77,13 @@ The `<group>` element is an implementation of a [`@group`] Codeception tag.
 Any test can be a part of multiple groups.
 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.
 
-{:.bs-callout .bs-callout-warning}
-Group values cannot collide with [suite] names.
+<div class="bs-callout bs-callout-warning" markdown="1">
+Group values cannot collide with [suite][] names.
+</div>
 
-{:.bs-callout .bs-callout-tip}
+<div class="bs-callout bs-callout-tip" markdown="1">
 Add `<skip>` to the test to skip it during test run.
+</div>
 
 Attribute|Type|Use|Definition
 ---|---|---|---
diff --git a/docs/tips-tricks.md b/docs/tips-tricks.md
@@ -13,7 +13,7 @@ In the bad example we see two parameters being passed into the selector with lit
 
 **Why?** The next person maintaining the test or extending it may not be able to understand what the parameters are referencing.
 
-<span stype="color:green">
+<span style="color:green">
 Good
 </span>
 
@@ -54,7 +54,7 @@ In the bad example, we perform some heavy UI steps first.
 
 **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.
 
-<span stype="color:green">
+<span style="color:green">
 Good:
 </span>
 
@@ -108,7 +108,7 @@ And for `seeElement` it will output something like this:
 There is a subtle distinction: The first is a failure but it is the desired result: a 'positive failure'.
 The second is a proper result of the action.
 
-<span stype="color:green">
+<span style="color:green">
 Good:
 </span>
 
@@ -128,7 +128,7 @@ Bad:
 
 Whenever possible, specify a `defaultValue` for action group arguments.
 
-<span stype="color:green">
+<span style="color:green">
 GOOD:
 </span>
 
@@ -176,7 +176,7 @@ Build your tests using action groups, even if an action group contains a single
 Extending a single action group will update all tests that use this group.
 This improves maintainability as multiple instances of a failure can be fixed with a single action group update.
 
-<span stype="color:green">
+<span style="color:green">
 GOOD:
 </span>
 
@@ -234,7 +234,7 @@ Do not use numbers to make a `stepKey` unique.
 
 **Why?** This helps with readability and clarity.
 
-<span stype="color:green">
+<span style="color:green">
 GOOD:
 </span>
 
@@ -308,7 +308,7 @@ Example:
 </div>
 ```
 
-<span stype="color:green">
+<span style="color:green">
 GOOD:
 </span>
 
@@ -358,7 +358,7 @@ BAD:
 Use descriptive variable names to increase readability.
 **Why?** It makes the code easier to follow and update.
 
- <span stype="color:green">
+ <span style="color:green">
 GOOD:
 </span>
 
@@ -379,7 +379,7 @@ BAD:
 When working with input type `checkbox`, do not use the `click` action; use `checkOption` or `uncheckOption` instead.
 **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.
 
-<span stype="color:green">
+<span style="color:green">
 GOOD:
 </span>
 
diff --git a/docs/update.md b/docs/update.md
@@ -1,7 +1,7 @@
 # Update the Magento Functional Testing Framework
 
-<div class="bs-callout bs-callout-info">
-<a href="https://devdocs.magento.com/mftf/introduction.html#find-version">Find out your version</a> of the MFTF.
+<div class="bs-callout bs-callout-info" markdown="1">
+[Find your version][] of the MFTF.
 
 The latest Magento 2.3 release supports MFTF 2.3.13.
 The latest Magento 2.2 release supports MFTF 2.3.8.
@@ -76,4 +76,5 @@ To update the MFTF from the previous minor version:
 <!-- Link Definitions -->
 [Changelog]: https://github.com/magento/magento2-functional-testing-framework/blob/master/CHANGELOG.md
 [WYSIWYG settings]: getting-started.md#wysiwyg-settings
-[Security settings]: getting-started.md#security-settings
+[Security settings]: getting-started.md#security-settings
+[Find your version]: introduction.md#find-your-mftf-version
diff --git a/docs/versioning.md b/docs/versioning.md
@@ -24,12 +24,15 @@ MFTF versioning policy follows [Semantic Versioning](https://semver.org/) guidel
 
 Version numbering schemes help users to understand the scope of the changes made a new release.
 
+```tree
 X.Y.Z
 | | |
 | | +-- Backward Compatible changes (Patch release - bug fixes, small additions)
 | +---- Backward Compatible changes (Minor release - small new features, bug fixes)
 +------ Backward Incompatible changes (Major release - new features and/or major changes)
 
+```
+
 For example:
 
 - Magento 2 ships with MFTF version 2.3.9
