MAGEDOC-2653: [mftf][reference] Create the Section topic

- technical review edits
- internal links' fixes

Author: dshevtsov

guides/v2.3/magento-functional-testing-framework/cest/actions.md

@@ -3,7 +3,7 @@ layout: default
 group: mftf
 title: Actions in the Magento Functional Testing Framework cests
 version: 2.3
-github_link: magento-functional-testing-framework/actions.md
+github_link: magento-functional-testing-framework/cest/actions.md
 ---
 
 This topic contains a reference list of available action type tags available in the MFTF cests.
@@ -23,7 +23,6 @@ All actions contain the following attributes that are useful for merging needs:
 
 ## Principles
 
-
 `mergeKey` value format principles:
 
 * Must be unique within [`<test>`](../cest.html#test)
@@ -35,7 +34,7 @@ All actions contain the following attributes that are useful for merging needs:
 * Should be the last attribute of an element
 
 ## Example
-
+{%raw%}
 The following example contains four actions:
 
 1. [Open the Sign In page for a Customer](#example-step1)
@@ -44,20 +43,16 @@ The following example contains four actions:
 4. [Click the Sign In button](#example-step4)
 
 ```xml
-{%raw%}
 <amOnPage mergeKey="amOnSignInPage"  url="{{StorefrontCustomerSignInPage}}"/>
 <fillField  mergeKey="fillEmail" userInput="$$customer.email$$" selector="{{StorefrontCustomerSignInFormSection.emailField}}"/>
 <fillField  mergeKey="fillPassword" userInput="$$customer.password$$" selector="{{StorefrontCustomerSignInFormSection.passwordField}}"/>
 <click mergeKey="clickSignInAccountButton" selector="{{StorefrontCustomerSignInFormSection.signInAccountButton}}"/>
-{%endraw%}
 ```
 
-#### 1. Open the Sign In page for a Customer {#example-step2}
+#### 1. Open the Sign In page for a Customer {#example-step1}
 
 ```xml
-{%raw%}
 <amOnPage mergeKey="amOnSignInPage"  url="{{StorefrontCustomerSignInPage.url}}"/>
-{%endraw%}
 ```
 
 The Customer Sign In page is declared in the _.../Customer/Page/StorefrontCustomerSignInPage.xml_.
@@ -66,7 +61,6 @@ The given relative URI is declared in `StorefrontCustomerSignInPage.url`
 The _StorefrontCustomerSignInPage.xml_ source code:
 
 ```xml
-
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="../../../../../../vendor/magento/magento2-functional-testing-framework/src/Magento/FunctionalTestingFramework/Page/etc/PageObject.xsd">
     <page name="StorefrontCustomerSignInPage" url="/customer/account/login/" module="Magento_Customer">
@@ -82,14 +76,12 @@ Here, `url` contains a pointer to a `url` attribute of the `StorefrontCustomerSi
 #### 2. Enter customer's e-mail  {#example-step2}
 
 ```xml
-{%raw%}
 <fillField  mergeKey="fillEmail" userInput="$$customer.email$$" selector="{{StorefrontCustomerSignInFormSection.emailField}}"/>
-{%endraw%}
 ```
 
 [fillField](#fillfield) fills a text field with the given string.
 
-The customer's e-mail is stored in the `email` parameter of the `customer` entity created somewhere earlier it the test using a tag [createData](#createData).
+The customer's e-mail is stored in the `email` parameter of the `customer` entity created somewhere earlier it the test using a tag [createData](#createdata).
 `userInput` points to that data.
 
 `selector` points to the field where to enter the data.
@@ -112,9 +104,7 @@ This section is declared in _.../Customer/Section/StorefrontCustomerSignInFormSe
 #### 3. Enter customer's password  {#example-step3}
 
 ```xml
-{%raw%}
 <fillField  mergeKey="fillPassword" userInput="$$customer.password$$" selector="{{StorefrontCustomerSignInFormSection.passwordField}}"/>
-{%endraw%}
 ```
 
 The action here is very similar to the action in a previous step.
@@ -124,14 +114,12 @@ The only difference is that different data assigned to the attributes which set
 #### 4. Click the Sign In button {#example-step4}
 
 ```xml
-{%raw%}
 <click mergeKey="clickSignInAccountButton" selector="{{StorefrontCustomerSignInFormSection.signInAccountButton}}"/>
-{%endraw%}
 ```
 
 Here, [click](#click) performs a click on a button that can be found by selector that is stored in the `signInAccountButton` of the `StorefrontCustomerSignInFormSection`.
 See the _StorefrontCustomerSignInPage.xml_ code in [step 2](#section-code)
-
+{%endraw%}
 ## Available actions
 
 The following list contains reference documentation about all action elements available in the MFTF.

guides/v2.3/magento-functional-testing-framework/cest/annotations.md

@@ -3,7 +3,7 @@ layout: default
 group: mftf
 title: Annotations in the Magento Functional Testing Framework cests
 version: 2.3
-github_link: magento-functional-testing-framework/annotations.md
+github_link: magento-functional-testing-framework/cest/annotations.md
 ---
 
 This topic contains a reference list of available annotations in the MFTF cests.

guides/v2.3/magento-functional-testing-framework/commands/codeception.md

@@ -373,7 +373,7 @@ Use custom path for config
 [env]: http://codeception.com/docs/07-AdvancedUsage#Environments
 [examples]: http://codeception.com/docs/reference/Commands#Run
 
-[--env]: #env
+[--env]: #--env
 [robo]: robo.html
 
 <!-- Abbreviations -->

guides/v2.3/magento-functional-testing-framework/commands/robo.md

@@ -167,7 +167,7 @@ The following list contains commands and options available in __Robo 1.1.3__.
 
 #### build
 
-[`build:project`](#build:project)     |Clone the Example configuration files Build the Codeception project
+[`build:project`](#buildproject)     |Clone the Example configuration files Build the Codeception project
 
 #### clone
 
@@ -179,7 +179,7 @@ The following list contains commands and options available in __Robo 1.1.3__.
 
 #### self
 
-[`self:update`](#self:update) or `update`       |Updates the `robo.phar` to the latest version. Only works when running the `phar` version of Robo.
+[`self:update`](#selfupdate) or `update`       |Updates the `robo.phar` to the latest version. Only works when running the `phar` version of Robo.
 
 ***
 ***

guides/v2.3/magento-functional-testing-framework/contribution-guidelines.md

@@ -50,7 +50,9 @@ To fork a repository on Github, do the following:
 3.	Click **Fork** at the top right:
 4.	Clone the repo into your development environment and start playing.
 
+{%collapsible Show how fork the repo%}
 ![MFTF forking](./img/mftf-fork.gif)
+{%endcollapsible%}
 
 ### Update the fork with the latest changes
 

guides/v2.3/magento-functional-testing-framework/getting-started.md

@@ -3,7 +3,7 @@ layout: default
 group: mftf
 title: Getting started with the Magento Functional Testing Framework
 version: 2.3
-github_link: magento-functional-testing-framework/running-tests.md
+github_link: magento-functional-testing-framework/getting-started.md
 ---
 
 <div class="bs-callout bs-callout-info" markdown="1">
@@ -219,7 +219,7 @@ $ vendor/bin/robo allure2:report
 <!-- LINKS -->
 
 [`codecept`]: commands/codeception.html
-[`robo]: commands/robo.html
+[`robo`]: commands/robo.html
 [allure commands]: commands/robo.html#allure-robo-commands
 
 [git]: https://git-scm.com/downloads

guides/v2.3/magento-functional-testing-framework/page.md

@@ -3,11 +3,9 @@ layout: default
 group: mftf
 title: Page structure in the Magento Functional Testing Framework
 version: 2.3
-github_link: magento-functional-testing-framework/page/structure.md
+github_link: magento-functional-testing-framework/page/structure.m
 ---
 
-{%raw%}
-
 ## Overview
 
 The MFTF employs a modified concept of [PageObjects].
@@ -18,10 +16,10 @@ In this way, you reuse sections and maintain a reusable single source of truth t
 Avoiding hardcoded location selectors from tests increases the maintainability and readability of tests, and test execution output/logging.
 
 Two types of pages are available:
- 
+ {%raw%}
  * page with `url` declared as a constant string or [explicit page]. It is called in a test in a format like `{{NameOfPage.url}}` , where `NameOfPage` is a value of `name` in corresponding page declaration _*.xml_ file.
  * page with `url` declared as a string with one or more variables or [parameterized page]. It is called in a test using a format like `{{NameOfPage.url(var1, var2, ...)}}`, where `var1, var2, ...` are parameters that will be substituted in `url` of the corresponding `<page>` declaration.  
-
+{%endraw%}
 The following diagram demonstrates XML structure of a page in the MFTF:
 
 {% include_relative img/page-dia.svg %}
@@ -84,19 +82,16 @@ The `AdminCategoryPage` declares four [sections][section]:
  * `AdminCategorySEOSection` that is located in _Catalog/Section/AdminCategorySEOSection.xml_
 
 Example of a call in test:
- 
+{%raw%}
 ```xml
-
 <amOnPage url="{{AdminCategoryPage.url}}" mergeKey="navigateToAdminCategory"/>
-
 ```
 
 ### Parameterized page
 
 _Catalog/Page/StorefrontCategoryPage.xml_ is provided as an example::
 
-```xml
- 
+```xml 
 <?xml version="1.0" encoding="UTF-8"?>
 
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -105,7 +100,6 @@ _Catalog/Page/StorefrontCategoryPage.xml_ is provided as an example::
         <section name="StorefrontCategoryMainSection"/>
     </page>
 </config>
-
 ```
 
 This example shows page with name `StorefrontCategoryPage`.
@@ -114,9 +108,7 @@ It will be merged with other `StorefrontCategoryPage` pages from other modules.
 Example of a call in test:
 
 ```xml
-
 <amOnPage url="{{StorefrontCategoryPage.url($$createPreReqCategory.name$$)}}" mergeKey="navigateToCategoryPage"/>
-
 ```
 
 The `StorefrontCategoryPage` page is declared as parameterized, where `url` contains a `{{var1}}` parameter.
@@ -162,6 +154,6 @@ remove|boolean|optional|Default value: `"false"`. Set to `"true"` to remove this
 [PageObjects]: https://github.com/SeleniumHQ/selenium/wiki/PageObjects
 [test]: cest.html
 [createData]: cest/actions.html#createdata
-
+[section]: section.html
 [explicit page]: #explicit-page
 [parameterized page]: #parameterized-page

guides/v2.3/magento-functional-testing-framework/section.md

@@ -2,13 +2,13 @@
 layout: default
 group: mftf
 title: Section structure in the Magento Functional Testing Framework
+version: 2.3
 github_link: magento-functional-testing-framework/section/structure.md
 ---
 
-{%raw%}
-
 ## Overview
 
+{%raw%}
 A section is a reusable part of a [page].
 It is the standard file for defining UI elements on a page used under test.
 
@@ -18,7 +18,7 @@ You are able to define:
 Example: `selector="#add_root_category_button"`
 - parameterized element that contains substitutable values in selector.
 Example: `selector="#element .{{var1}} .{{var2}}"`.
-
+{% endraw %}
 ### Substitutable values
 
 Sustainable values in the test can be of the following formats:
@@ -31,6 +31,7 @@ Sustainable values in the test can be of the following formats:
 
 The following diagram demonstrates XML structure of a section in the MFTF:
 
+
 {%include_relative img/section-dia.svg%}
 
 ## Format
@@ -81,12 +82,11 @@ The section declares two buttons:
 * `AddSubcategoryButton` is a button with a locator `#add_subcategory_button` on the parent web page. 
 
 Example of a call in test:
-
+{%raw%}
 ```xml
 <!-- Click on the button with locator "#add_subcategory_button" on the web page-->
 <click selector="{{AdminCategorySidebarActionSection.AddSubcategoryButton}}" mergeKey="clickOnAddSubCategory"/>
 ```
-
 ## Available elements
 
 ### section {#section-ref}
@@ -118,4 +118,8 @@ remove|boolean|optional|Default: `false`. Set to `true` to remove this element d
 [action]: cest/actions.html
 [page]: page.html
 [CSS]: https://www.w3schools.com/cssref/css_selectors.asp
-[XPath]: https://www.w3schools.com/xml/xpath_nodes.asp
+[XPath]: https://www.w3schools.com/xml/xpath_nodes.asp
+[cest]: cest.html
+[test]: cest.html#test
+[createData]: cest/actions.html#createdata
+[before]: cest.html#before

guides/v2.3/magento-functional-testing-framework/section/parameterized-selectors.md

@@ -2,7 +2,8 @@
 layout: default
 group: mftf
 title: Create and use parameterized selectors in the Magento Functional Testing Framework
-github_link: magento-functional-testing-framework/section/structure/parameterized-selectors.md
+version: 2.3
+github_link: magento-functional-testing-framework/section/parameterized-selectors.md
 ---
 
 {%raw%}
@@ -81,16 +82,15 @@ Add the 2nd/3rd parameters that you'd like to pass to the selector separated by
 
 Here,
 
-* `_defaultCategory.is_active` is a reference to `<data key="is_active">` in `<entity name="_defaultCategory" ... ></entity>` in _Data_
+* `_defaultCategory.is_active` is a reference to `<data key="is_active">` in `<entity name="_defaultCategory" ... ></entity>` in the corresponding _.../Data/*.xml_
 * `stringLiteral` is a literal
-* `$createDataKey.id$` is a reference to persisted data created in the `SampleTest` using action with `mergeKey="createDataKey"`
+* `$createDataKey.id$` is a reference to persisted data created in the `SampleCest1` within action with `mergeKey="createDataKey"`
 
 {%endraw%}
 
 
 <!-- LINK DEFINITIONS -->
 
-
 <!-- Internal -->
 
 [test]: ../cest.html#test

guides/v2.3/magento-functional-testing-framework/troubleshooting.md

@@ -3,7 +3,7 @@ layout: default
 group: mftf
 title: Troubleshooting in the Magento Functional Testing Framework
 version: 2.3
-github_link: magento-functional-testing-framework/commands/troubleshooting.md
+github_link: magento-functional-testing-framework/troubleshooting.md
 ---
 
 ## WebDriver issues