MQE-2214: Part 1 Docs Annual Review

Author: tomreece

docs/configuration.md

@@ -221,13 +221,13 @@ The path to where the MFTF modules mirror Magento modules.
 Example:
 
 ```conf
-TESTS_MODULE_PATH=~/magento2/dev/tests/acceptance/tests/functional/Magento/FunctionalTest
+TESTS_MODULE_PATH=~/magento2/dev/tests/acceptance/tests/functional/Magento
 ```
 
 ### MODULE_ALLOWLIST
 
 Use for a new module.
-When adding a new directory at `Magento/FunctionalTest`, add the directory name to `MODULE_ALLOWLIST` to enable MFTF to process it.
+When adding a new directory at `tests/functional/Magento`, add the directory name to `MODULE_ALLOWLIST` to enable MFTF to process it.
 
 Example:
 

docs/extending.md

@@ -177,14 +177,14 @@ Extend an [action group] to add or update [actions] in your module.
 
 ### Update an action
 
-__Use case__: The `CountProductA` test counts the particular product.
+__Use case__: The `AssertAdminCountProductActionGroup` action group counts the particular product.
 Modify the action group to use another product.
 
 > Action groups with "extends":
 
 ```xml
 <actionGroups>
-    <actionGroup name="CountProductA">
+    <actionGroup name="AssertAdminCountProductActionGroup">
         <arguments>
             <argument name="count" type="string"/>
         </arguments>
@@ -195,7 +195,7 @@ Modify the action group to use another product.
         </assertCount>
     </actionGroup>
 
-    <actionGroup name="CountProductB" extends="CountProductA">
+    <actionGroup name="AssertAdminOtherCountProductActionGroup" extends="AssertAdminCountProductActionGroup">
         <grabMultiple selector="selectorForProductB" stepKey="grabProducts"/>
     </actionGroup>
 </actionGroups>
@@ -205,7 +205,7 @@ Modify the action group to use another product.
 
 ```xml
 <actionGroups>
-    <actionGroup name="CountProductA">
+    <actionGroup name="AssertAdminCountProductActionGroup">
         <arguments>
             <argument name="count" type="string"/>
         </arguments>
@@ -216,7 +216,7 @@ Modify the action group to use another product.
         </assertCount>
     </actionGroup>
 
-    <actionGroup name="CountProductB">
+    <actionGroup name="AssertAdminOtherCountProductActionGroup">
         <arguments>
             <argument name="count" type="string"/>
         </arguments>
@@ -231,21 +231,21 @@ Modify the action group to use another product.
 
 ### Add an action
 
-__Use case__: The `GetProductCount` action group returns the count of products.
-Add a new test `VerifyProductCount` that asserts the count of products:
+__Use case__: The `AdminGetProductCountActionGroup` action group returns the count of products.
+Add a new test `AssertAdminVerifyProductCountActionGroup` that asserts the count of products:
 
 > Action groups with "extends":
 
 ```xml
 <actionGroups>
-    <actionGroup name="GetProductCount">
+    <actionGroup name="AdminGetProductCountActionGroup">
         <arguments>
             <argument name="productSelector" type="string"/>
         </arguments>
         <grabMultiple selector="{{productSelector}}" stepKey="grabProducts"/>
     </actionGroup>
 
-    <actionGroup name="VerifyProductCount" extends="GetProductCount">
+    <actionGroup name="AssertAdminVerifyProductCountActionGroup" extends="AdminGetProductCountActionGroup">
         <arguments>
             <argument name="count" type="string"/>
         </arguments>
@@ -261,14 +261,14 @@ Add a new test `VerifyProductCount` that asserts the count of products:
 
 ```xml
 <actionGroups>
-    <actionGroup name="GetProductCount">
+    <actionGroup name="AdminGetProductCountActionGroup">
         <arguments>
             <argument name="productSelector" type="string"/>
         </arguments>
         <grabMultiple selector="{{productSelector}}" stepKey="grabProducts"/>
     </actionGroup>
 
-    <actionGroup name="VerifyProductCount">
+    <actionGroup name="AssertAdminVerifyProductCountActionGroup">
         <arguments>
             <argument name="count" type="string"/>
             <argument name="productSelector" type="string"/>

docs/getting-started.md

@@ -44,7 +44,7 @@ cd magento2/
 ```
 
 ```bash
-git checkout 2.3-develop
+git checkout 2.4-develop
 ```
 
 Install the Magento application.
@@ -241,10 +241,10 @@ See more commands in [`codecept`][].
 
 #### Run a simple test {#run-test}
 
-To clean up the previously generated tests, and then generate and run a single test `AdminLoginTest`, run:
+To clean up the previously generated tests, and then generate and run a single test `AdminLoginSuccessfulTest`, run:
 
 ```bash
-vendor/bin/mftf run:test AdminLoginTest --remove
+vendor/bin/mftf run:test AdminLoginSuccessfulTest --remove
 ```
 
 See more commands in [`mftf`][].
@@ -315,7 +315,7 @@ composer remove magento/magento2-functional-testing-framework --dev -d <path to
 Generate and run a single test that will check your logging to the Magento Admin functionality:
 
 ```bash
-bin/mftf run:test AdminLoginTest
+bin/mftf run:test AdminLoginSuccessfulTest
 ```
 
 You can find the generated test at `dev/tests/functional/tests/MFTF/_generated/default/`.