Merge pull request #8886 from commerce-docs/ds_docs-fix

COMDOX-852: Minor fixes in docs
magento · Oct 17, 2024 · b832b85 · b832b85
2 parents f130be4 + 839ece3
commit b832b85
Show file tree

Hide file tree

Showing 14 changed files with 39 additions and 37 deletions.
diff --git a/app/code/Magento/ApplicationPerformanceMonitor/README.md b/app/code/Magento/ApplicationPerformanceMonitor/README.md
@@ -1,11 +1,11 @@
-**ApplicationPerformanceMonitor**
+# ApplicationPerformanceMonitor
 
 Monitors the Performance of the Application
 
 To configure, edit app/etc/env.php
 Add these lines.
 
-```
+```php
 'application' => [
     'performance_monitor' => [
         'logger_output_enable' => 1,
@@ -21,7 +21,8 @@ The option `logger_output_enable` enables outputting performance metrics to the
 The option `logger_output_verbose` adds additional metrics.
 
 Example output in log file without verbose:
-```
+
+```log
 [2023-10-04T20:48:23.727037+00:00] report.ERROR: "Profile information": {
         "applicationClass":     "Magento\ApplicationServer\App\Application\Interceptor",
         "applicationServer":    "1",
@@ -36,7 +37,8 @@ Example output in log file without verbose:
 ```
 
 Example output in log file with verbose:
-```
+
+```log
 [2023-10-04T20:55:31.174304+00:00] report.ERROR: "Profile information": {
         "applicationClass":     "Magento\ApplicationServer\App\Application\Interceptor",
         "applicationServer":    "1",

diff --git a/app/code/Magento/ApplicationPerformanceMonitorNewRelic/README.md b/app/code/Magento/ApplicationPerformanceMonitorNewRelic/README.md
@@ -1,21 +1,22 @@
-**ApplicationPerformanceMonitorNewRelic**
+# ApplicationPerformanceMonitorNewRelic
 
 Monitors the Performance of the Application in New Relic
 
 To use this module, it requires a New Relic account and the environment already by configured to use that account.
-For general New Relic PHP configuration information, see https://docs.newrelic.com/docs/apm/agents/php-agent/configuration/php-agent-configuration/ .
+For general New Relic PHP configuration information, see <https://docs.newrelic.com/docs/apm/agents/php-agent/configuration/php-agent-configuration/>.
 
-To configure this module, edit app/etc/env.php
+To configure this module, edit `app/etc/env.php`.
 Add these lines.
 
-```
+```php
 'application' => [
     'performance_monitor' => [
         'newrelic_output_enable' => 1,
         'newrelic_output_verbose' => 0,
     ]
 ]
 ```
+
 Use 0 or 1 as the value to enable or disable.
 `newrelic_output_enable` defaults to 1, and `newrelic_output_verbose` defaults to 0.
 

diff --git a/app/code/Magento/CustomerGraphQl/README.md b/app/code/Magento/CustomerGraphQl/README.md
@@ -27,8 +27,8 @@ You can get more information about [GraphQl In Magento 2](https://developer.adob
 
 ### GraphQl Query
 
-- `customer` query - returns information about the logged-in customer, store credit history and customer’s wishlist
+- `customer` query - returns information about the logged-in customer, store credit history and customer's wishlist
 - `isEmailAvailable` query - checks whether the specified email has already been used to create a customer account. A value of true indicates the email address is available, and the customer can use the email address to create an account
 
 [Learn more about customer query](https://developer.adobe.com/commerce/webapi/graphql/schema/customer/queries/customer/).
-[Learn more about isEmailAvailable query](https://developer.adobe.com/commerce/webapi/graphql/usage/is-email-available.html).
+[Learn more about isEmailAvailable query](https://developer.adobe.com/commerce/webapi/graphql/schema/customer/queries/is-email-available).
diff --git a/app/code/Magento/InstantPurchase/README.md b/app/code/Magento/InstantPurchase/README.md
@@ -96,7 +96,7 @@ Basic implementation is a good start point but it's recommended to provide own i
 
 The `Magento_InstantPurchase` module does not introduce backward incompatible changes.
 
-You can track [backward incompatible changes in patch releases](https://developer.adobe.com/commerce/php/development/backward-incompatible-changes/highlights/reference.html).
+You can track [backward incompatible changes in patch releases](https://developer.adobe.com/commerce/php/development/backward-incompatible-changes/highlights/).
 
 ***
 

diff --git a/app/code/Magento/IntegrationGraphQl/README.md b/app/code/Magento/IntegrationGraphQl/README.md
@@ -1,6 +1,6 @@
 # Magento_IntegrationGraphQl module
 
-This module provides GraphQl resolvers for Integartion module. 
+This module provides GraphQl resolvers for Integration module.
 
 ## Installation
 

diff --git a/app/code/Magento/MediaGallery/README.md b/app/code/Magento/MediaGallery/README.md
@@ -22,4 +22,4 @@ Extension developers can interact with the Magento_MediaGallery module. For more
 
 For information about significant changes in patch releases, see [2.4.x Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html).
 
-[Learn more about New Media Gallery](https://experienceleague.adobe.com/docs/commerce-admin/content-design/media/gallery/media-gallery.html).
+[Learn more about New Media Gallery](https://experienceleague.adobe.com/en/docs/commerce-admin/content-design/wysiwyg/gallery/media-gallery).
diff --git a/app/code/Magento/MediaGalleryUi/README.md b/app/code/Magento/MediaGalleryUi/README.md
@@ -44,4 +44,4 @@ For information about a UI component in Magento 2, see [Overview of UI component
 
 For information about significant changes in patch releases, see [2.4.x Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html).
 
-[Learn more about New Media Gallery](https://experienceleague.adobe.com/docs/commerce-admin/content-design/media/gallery/media-gallery.html).
+[Learn more about New Media Gallery](https://experienceleague.adobe.com/en/docs/commerce-admin/content-design/wysiwyg/gallery/media-gallery).
diff --git a/app/code/Magento/MediaGalleryUiApi/README.md b/app/code/Magento/MediaGalleryUiApi/README.md
@@ -10,4 +10,4 @@ For information about module installation in Magento 2, see [Enable or disable m
 
 For information about significant changes in patch releases, see [2.4.x Release information](https://experienceleague.adobe.com/docs/commerce-operations/release/notes/overview.html).
 
-[Learn more about New Media Gallery](https://experienceleague.adobe.com/docs/commerce-admin/content-design/media/gallery/media-gallery.html).
+[Learn more about New Media Gallery](https://experienceleague.adobe.com/en/docs/commerce-admin/content-design/wysiwyg/gallery/media-gallery).
diff --git a/app/code/Magento/MediaStorage/README.md b/app/code/Magento/MediaStorage/README.md
@@ -37,5 +37,5 @@ Extension developers can interact with the Magento_MediaStorage module. For more
 
 More information can get at articles:
 
-- [Learn how to configure Media Storage Database](https://experienceleague.adobe.com/docs/commerce-admin/content-design/media/storage/media-storage-database.html).
+- [Learn how to configure Media Storage Database](https://experienceleague.adobe.com/en/docs/commerce-admin/content-design/wysiwyg/storage/media-storage-database).
 - [Learn how to Resize catalog images](https://developer.adobe.com/commerce/frontend-core/guide/themes/configure/#resize-catalog-images)
diff --git a/app/code/Magento/NewRelicReporting/README.md b/app/code/Magento/NewRelicReporting/README.md
@@ -31,7 +31,7 @@ Extension developers can interact with the Magento_NewRelicReporting module. For
 
 ## Additional information
 
-[Learn more about New Relic Reporting](https://experienceleague.adobe.com/docs/commerce-admin/start/reporting/new-relic-reporting.html).
+[Learn more about New Relic Reporting](https://experienceleague.adobe.com/en/docs/commerce-operations/tools/cli-reference/commerce-on-premises#newreliccreatedeploy-marker).
 
 ### Console commands
 

diff --git a/app/code/Magento/OrderCancellationUi/README.md b/app/code/Magento/OrderCancellationUi/README.md
@@ -1,4 +1,3 @@
 # Magento_OrderCancellationUi module
 
 This module allows to cancel an order and specify the order cancellation reason in the storefront. Only orders in `RECEIVED`, `PENDING` or `PROCESSING` statuses can be cancelled. If the customer has paid for the order a refund is processed.
-
diff --git a/app/code/Magento/QuoteGraphQl/README.md b/app/code/Magento/QuoteGraphQl/README.md
@@ -46,37 +46,37 @@ You can get more information about [GraphQl In Magento 2](https://developer.adob
   [Learn more about applyCouponToCart mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/apply-coupon/).
 
 - `removeCouponFromCart` mutation - removes a previously-applied coupon from the cart.
-  [Learn more about removeCouponFromCart mutation](https://developer.adobe.com/commerce/webapi/graphql/mutations/remove-coupon.html).
+  [Learn more about removeCouponFromCart mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/remove-coupon/).
 
 - `updateCartItems` mutation - allows you to modify items in the specified cart.
-  [Learn more about updateCartItems mutation](https://developer.adobe.com/commerce/webapi/graphql/mutations/update-cart-items.html).
+  [Learn more about updateCartItems mutation]((https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/update-items/).
 
 - `removeItemFromCart` mutation - deletes the entire quantity of a specified item from the cart.
-  [Learn more about removeItemFromCart mutation](https://developer.adobe.com/commerce/webapi/graphql/mutations/remove-item.html).
+  [Learn more about removeItemFromCart mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/remove-item/).
 
 - `setShippingAddressesOnCart` mutation - sets one or more shipping addresses on a specific cart.
-  [Learn more about setShippingAddressesOnCart mutation](https://developer.adobe.com/commerce/webapi/graphql/mutations/set-shipping-address.html).
+  [Learn more about setShippingAddressesOnCart mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/set-shipping-address/).
 
 - `setBillingAddressOnCart` mutation - sets the billing address for a specific cart.
-  [Learn more about setBillingAddressOnCart mutation](https://developer.adobe.com/commerce/webapi/graphql/mutations/set-billing-address.html).
+  [Learn more about setBillingAddressOnCart mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/set-billing-address/).
 
 - `setShippingMethodsOnCart` mutation - sets one or more delivery methods on a cart.
-  [Learn more about setShippingMethodsOnCart mutation](https://developer.adobe.com/commerce/webapi/graphql/mutations/set-shipping-method.html).
+  [Learn more about setShippingMethodsOnCart mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/set-shipping-method/).
 
 - `setPaymentMethodOnCart` mutation - defines which payment method to apply to the cart.
-  [Learn more about setPaymentMethodOnCart mutation](https://developer.adobe.com/commerce/webapi/graphql/mutations/set-payment-method.html).
+  [Learn more about setPaymentMethodOnCart mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/set-payment-method/).
 
 - `setGuestEmailOnCart` mutation - assigns email to the guest cart.
-  [Learn more about setGuestEmailOnCart mutation](https://developer.adobe.com/commerce/webapi/graphql/mutations/set-guest-email.html).
+  [Learn more about setGuestEmailOnCart mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/set-guest-email/).
 
 - `setPaymentMethodAndPlaceOrder` mutation - sets the cart payment method and converts the cart into an order. **This mutation has been deprecated**. Use the `setPaymentMethodOnCart` and `placeOrder` mutations instead.
-  [Learn more about setPaymentMethodAndPlaceOrder mutation](https://developer.adobe.com/commerce/webapi/graphql/mutations/set-payment-place-order.html).
+  [Learn more about setPaymentMethodAndPlaceOrder mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/set-payment-place-order/).
 
 - `mergeCarts` mutation - transfers the contents of a guest cart into the cart of a logged-in customer.
-  [Learn more about mergeCarts mutation](https://developer.adobe.com/commerce/webapi/graphql/mutations/merge-carts.html).
+  [Learn more about mergeCarts mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/merge/).
 
 - `placeOrder` mutation - converts the cart into an order and returns an order ID.
-  [Learn more about placeOrder mutation](https://developer.adobe.com/commerce/webapi/graphql/mutations/place-order.html).
+  [Learn more about placeOrder mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/place-order/).
 
 - `addProductsToCart` mutation - adds any type of product to the shopping cart.
   [Learn more about addProductsToCart mutation](https://developer.adobe.com/commerce/webapi/graphql/schema/cart/mutations/add-products/).

diff --git a/app/code/Magento/WishlistGraphQl/README.md b/app/code/Magento/WishlistGraphQl/README.md
@@ -33,10 +33,10 @@ For more information about the Magento_WishlistGraphQl queries and mutations see
 
 ### Queries
 
-- [`wishlist`](https://developer.adobe.com/commerce/webapi/graphql/usage/wishlist.html)
+- [`wishlist`](https://developer.adobe.com/commerce/webapi/graphql/schema/wishlist/queries/wishlist/)
 
 ### Mutations
 
 - [`addProductsToWishlist`](https://developer.adobe.com/commerce/webapi/graphql/schema/wishlist/mutations/add-products/)
-- [`removeProductsFromWishlist`](https://developer.adobe.com/commerce/webapi/graphql/mutations/remove-products-from-wishlist.html)
-- [`updateProductsInWishlist`](https://developer.adobe.com/commerce/webapi/graphql/mutations/update-products-in-wishlist.html)
+- [`removeProductsFromWishlist`](https://developer.adobe.com/commerce/webapi/graphql/schema/wishlist/mutations/remove-products/)
+- [`updateProductsInWishlist`](https://developer.adobe.com/commerce/webapi/graphql/schema/wishlist/mutations/update-products/)
diff --git a/...ests/integration/testsuite/Magento/Config/Model/Config/Structure/Reader/_files/config.xml b/...ests/integration/testsuite/Magento/Config/Model/Config/Structure/Reader/_files/config.xml
@@ -74,7 +74,7 @@
                     <label>Payments Pro</label>
                     <attribute type="activity_path">payment/paypal_payment_pro/active</attribute>
                     <group id="configuration_details">
-                        <comment>https://docs.magento.com/user-guide/payment/paypal-payments-pro.html</comment>
+                        <comment>https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/payments/paypal/paypal-payments-pro</comment>
                     </group>
                     <group id="paypal_payflow_required" translate="label" showInDefault="1" showInWebsite="1" sortOrder="10">
                         <field id="enable_paypal_payflow">
@@ -94,7 +94,7 @@
                     <comment>Accept credit card and PayPal payments securely.</comment>
                     <attribute type="activity_path">payment/wps_express/active</attribute>
                     <group id="configuration_details">
-                        <comment>https://docs.magento.com/user-guide/payment/paypal-payments-standard.html</comment>
+                        <comment>https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/payments/paypal/paypal-payments-standard</comment>
                     </group>
                     <group id="express_checkout_required">
                         <group id="express_checkout_required_express_checkout">
@@ -162,7 +162,7 @@
                     <comment>Accept credit card and PayPal payments securely.</comment>
                     <attribute type="activity_path">payment/wps_express/active</attribute>
                     <group id="configuration_details">
-                        <comment>https://docs.magento.com/user-guide/payment/paypal-payments-standard.html</comment>
+                        <comment>https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/payments/paypal/paypal-payments-standard</comment>
                     </group>
                     <group id="express_checkout_required">
                         <group id="express_checkout_required_express_checkout">
@@ -233,7 +233,7 @@
                     <comment>Accept credit card and PayPal payments securely.</comment>
                     <attribute type="activity_path">payment/wps_express/active</attribute>
                     <group id="configuration_details">
-                        <comment>https://docs.magento.com/user-guide/payment/paypal-payments-standard.html</comment>
+                        <comment>https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/payments/paypal/paypal-payments-standard</comment>
                     </group>
                     <group id="express_checkout_required">
                         <group id="express_checkout_required_express_checkout">
@@ -278,7 +278,7 @@
                     <label>Website Payments Pro</label>
                     <attribute type="activity_path">payment/paypal_payment_pro/active</attribute>
                     <group id="configuration_details">
-                        <comment>https://docs.magento.com/user-guide/payment/paypal-payments-pro.html</comment>
+                        <comment>https://experienceleague.adobe.com/en/docs/commerce-admin/stores-sales/payments/paypal/paypal-payments-pro</comment>
                     </group>
                     <group id="paypal_payflow_required" translate="label" showInDefault="1" showInWebsite="1" sortOrder="10">
                         <group id="paypal_payflow_api_settings">