CABPI-429: Review and Update Project Documentation

Author: andimov

app/code/Magento/AdminAdobeIms/Console/Command/AdminAdobeImsEnableCommand.php

@@ -46,7 +46,7 @@ class AdminAdobeImsEnableCommand extends Command
     /**
      * Name of "two-factor-auth" input option
      */
-    private const TWO_FACTOR_AUTH_ARGUMENT = '2fa-auth';
+    private const TWO_FACTOR_AUTH_ARGUMENT = '2fa';
 
     /**
      * @var ImsConfig
@@ -119,7 +119,8 @@ public function __construct(
                     self::TWO_FACTOR_AUTH_ARGUMENT,
                     't',
                     InputOption::VALUE_OPTIONAL,
-                    'Check if 2FA Auth is enabled on Adobe IMS Side. Enables or disables the Magento 2FA'
+                    'Check if 2FA is enabled for Organization in Adobe Admin Console. ' .
+                    'Required when enabling the module'
                 )
             ]);
     }
@@ -169,7 +170,7 @@ protected function execute(InputInterface $input, OutputInterface $output): ?int
             }
 
             throw new LocalizedException(
-                __('The Client ID, Client Secret, Organization ID and 2FA Auth are required ' .
+                __('The Client ID, Client Secret, Organization ID and 2FA are required ' .
                     'when enabling the Admin Adobe IMS Module')
             );
         } catch (\Exception $e) {

app/code/Magento/AdminAdobeIms/README.md

@@ -6,7 +6,7 @@ For information about module installation in Magento 2, see [Enable or disable m
 # CLI command usage:
 ## bin/magento admin:adobe-ims:enable
 Enables the AdminAdobeIMS Module. \
-Required values are `Organization ID`, `Client ID`, `Client Secret` and `2FA enabled on AdobeIMS`
+Required values are `Organization ID`, `Client ID`, `Client Secret` and `2FA enabled`
 
 ### Argument Validation
 On enabling the AdminAdobeIMS Module, the input arguments will be validated. \
@@ -27,7 +27,7 @@ We check if the arguments are not empty, as they are all required.
 
 For the Organization ID, Client ID and Client Secret, we check if they contain only alphanumeric characters. \
 Additionally for the Organization ID, we check if it matches 24 characters and optional has the suffix `@AdobeOrg`. But we only store the ID and ignore the suffix.
-Also make sure 2FA is enabled on AdobeIMS.
+Also make sure 2FA is enabled for the Organization in Adobe Admin Console.
 
 ## bin/magento admin:adobe-ims:disable
 Disables the AdminAdobeIMS Module.
@@ -197,7 +197,7 @@ curl -X GET "{domain}/rest/V1/customers/2" -H "Authorization: Bearer AddAdobeIms
 curl -X GET "{domain}/rest/V1/products/24-MB01" -H "Authorization: Bearer AddAdobeImsAccessToken"
 
 ### Two-factor authentication.
-During CLI enablement of the module, the admin user is asked, whether 2FA is enabled for him on Adobe side.
+During CLI enablement of the module, the admin user is asked, whether 2FA is enabled for Organization in Adobe Admin Console.
 If the answer is yes, Magento TFA module (if it's present in the code base), should be disable.
 
 For this purpose the additional config value was added, this config value is read by Magento_TwoFactorAuth module.

app/code/Magento/AdminAdobeIms/Service/ImsCommandOptionService.php

@@ -22,9 +22,9 @@ class ImsCommandOptionService
     private const OPTION_QUESTION = 'Please enter your %s:';
 
     /**
-     * Prompt for 2FA Auth CLI Command option
+     * Prompt for 2FA CLI Command option
      */
-    private const TWO_FACTOR_OPTION_QUESTION = 'Is 2FA enabled on AdobeIMS? (yes/no):';
+    private const TWO_FACTOR_OPTION_QUESTION = 'Is 2FA enabled for Organization in Adobe Admin Console? (yes/no):';
 
     /**
      * Human-readable name for Organization ID input option

app/code/Magento/AdminAdobeIms/Service/ImsConfig.php

@@ -121,7 +121,7 @@ public function enableModule(
     ): void {
         if (!$isAdobeIms2FAEnabled) {
             throw new LocalizedException(
-                __('2FA Auth is required when enabling the Admin Adobe IMS Module')
+                __('2FA is required when enabling the Admin Adobe IMS Module')
             );
         }
 

app/code/Magento/AdminAdobeIms/Test/Unit/Command/AdminAdobeImsEnableCommandTest.php

@@ -171,23 +171,23 @@ public function cliCommandProvider(): array
                 false,
                 $this->never(),
                 $this->never(),
-                '<error>The Client ID, Client Secret, Organization ID and 2FA Auth are required ' .
+                '<error>The Client ID, Client Secret, Organization ID and 2FA are required ' .
                 'when enabling the Admin Adobe IMS Module</error>',
                 true
             ],
             [
                 true,
                 $this->never(),
                 $this->never(),
-                '<error>The Client ID, Client Secret, Organization ID and 2FA Auth are required ' .
+                '<error>The Client ID, Client Secret, Organization ID and 2FA are required ' .
                 'when enabling the Admin Adobe IMS Module</error>',
                 false
             ],
             [
                 false,
                 $this->never(),
                 $this->never(),
-                '<error>The Client ID, Client Secret, Organization ID and 2FA Auth are required ' .
+                '<error>The Client ID, Client Secret, Organization ID and 2FA are required ' .
                 'when enabling the Admin Adobe IMS Module</error>',
                 false
             ]