Skip to content

Commit cc11f1c

Browse files
sidolovsidolov
authored
ENGCOM-9211: [ReadMe] updated readMe file for QuoteBundleOptions-ReleaseNotification modules #33124 
2 parents b7e0179 + 1792378 commit cc11f1c

File tree

6 files changed

+168
-15
lines changed

6 files changed

+168
-15
lines changed

‎app/code/Magento/QuoteBundleOptions/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1-
# QuoteBundleOptions
1+
# Magento_QuoteBundleOptions module
22

3-
**QuoteBundleOptions** provides data provider for creating buy request for bundle products.
3+
This module provides data provider for creating buy request for bundle products.
4+
5+
## Installation
6+
7+
This module does not introduce any database schema modifications or new data.
8+
9+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
10+
11+
## Extensibility
12+
13+
Extension developers can interact with the Magento_QuoteBundleOptions module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
14+
15+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_QuoteBundleOptions module.

‎app/code/Magento/QuoteConfigurableOptions/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1-
# QuoteConfigurableOptions
1+
# Magento_QuoteConfigurableOptions module
22

3-
**QuoteConfigurableOptions** provides data provider for creating buy request for configurable products.
3+
This module provides data provider for creating buy request for configurable products.
4+
5+
## Installation
6+
7+
This module does not introduce any database schema modifications or new data.
8+
9+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
10+
11+
## Extensibility
12+
13+
Extension developers can interact with the Magento_QuoteConfigurableOptions module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
14+
15+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_QuoteConfigurableOptions module.

‎app/code/Magento/QuoteDownloadableLinks/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1-
# QuoteDownloadableLinks
1+
# Magento_QuoteDownloadableLinks module
22

3-
**QuoteDownloadableLinks** provides data provider for creating buy request for links of downloadable products.
3+
This module provides data provider for creating buy request for links of downloadable products.
4+
5+
## Installation
6+
7+
This module does not introduce any database schema modifications or new data.
8+
9+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
10+
11+
## Extensibility
12+
13+
Extension developers can interact with the Magento_QuoteDownloadableLinks module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
14+
15+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_QuoteDownloadableLinks module.

‎app/code/Magento/QuoteGraphQl/README.md

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,82 @@
1-
# QuoteGraphQl
1+
# Magento_QuoteGraphQl module
22

3-
**QuoteGraphQl** provides type and resolver information for the GraphQl module
3+
This module provides type and resolver information for the GraphQl module
44
to generate quote (cart) information endpoints. Also provides endpoints for modifying a quote.
5+
6+
## Installation
7+
8+
Before installing this module, note that the Magento_QuoteGraphQl is dependent on the following modules:
9+
- `Magento_CatalogGraphQl`
10+
11+
This module does not introduce any database schema modifications or new data.
12+
13+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
14+
15+
## Extensibility
16+
17+
Extension developers can interact with the Magento_QuoteDownloadableLinks module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
18+
19+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_QuoteDownloadableLinks module.
20+
21+
## Additional information
22+
23+
You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql).
24+
25+
### GraphQl Query
26+
27+
- `cart` query - retrieve information about a particular cart.
28+
[Learn more about cart query](https://devdocs.magento.com/guides/v2.4/graphql/queries/cart.html).
29+
30+
- `customerCart` query - returns the active cart for the logged-in customer. If the cart does not exist, the query creates one.
31+
[Learn more about customerCart query](https://devdocs.magento.com/guides/v2.4/graphql/queries/customer-cart.html).
32+
33+
### GraphQl Mutation
34+
35+
- `createEmptyCart` mutation - creates an empty shopping cart for a guest or logged in customer.
36+
[Learn more about createEmptyCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/create-empty-cart.html).
37+
38+
- `addSimpleProductsToCart` mutation - allows you to add any number of simple and group products to the cart at the same time.
39+
[Learn more about addSimpleProductsToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/add-simple-products.html).
40+
41+
- `addVirtualProductsToCart` mutation - allows you to add multiple virtual products to the cart at the same time, but you cannot add other product types with this mutation.
42+
[Learn more about addVirtualProductsToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/add-virtual-products.html).
43+
44+
- `applyCouponToCart` mutation - applies a pre-defined coupon code to the specified cart.
45+
[Learn more about applyCouponToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/apply-coupon.html).
46+
47+
- `removeCouponFromCart` mutation - removes a previously-applied coupon from the cart.
48+
[Learn more about removeCouponFromCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/remove-coupon.html).
49+
50+
- `updateCartItems` mutation - allows you to modify items in the specified cart.
51+
[Learn more about updateCartItems mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/update-cart-items.html).
52+
53+
- `removeItemFromCart` mutation - deletes the entire quantity of a specified item from the cart.
54+
[Learn more about removeItemFromCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/remove-item.html).
55+
56+
- `setShippingAddressesOnCart` mutation - sets one or more shipping addresses on a specific cart.
57+
[Learn more about setShippingAddressesOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-shipping-address.html).
58+
59+
- `setBillingAddressOnCart` mutation - sets the billing address for a specific cart.
60+
[Learn more about setBillingAddressOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-billing-address.html).
61+
62+
- `setShippingMethodsOnCart` mutation - sets one or more delivery methods on a cart.
63+
[Learn more about setShippingMethodsOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-shipping-method.html).
64+
65+
- `setPaymentMethodOnCart` mutation - defines which payment method to apply to the cart.
66+
[Learn more about setPaymentMethodOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-payment-method.html).
67+
68+
- `setGuestEmailOnCart` mutation - assigns email to the guest cart.
69+
[Learn more about setGuestEmailOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-guest-email.html).
70+
71+
- `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.
72+
[Learn more about setPaymentMethodAndPlaceOrder mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-payment-place-order.html).
73+
74+
- `mergeCarts` mutation - transfers the contents of a guest cart into the cart of a logged-in customer.
75+
[Learn more about mergeCarts mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/merge-carts.html).
76+
77+
- `placeOrder` mutation - converts the cart into an order and returns an order ID.
78+
[Learn more about placeOrder mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/place-order.html).
79+
80+
- `addProductsToCart` mutation - adds any type of product to the shopping cart.
81+
[Learn more about addProductsToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/add-products-to-cart.html).
82+

‎app/code/Magento/RelatedProductGraphQl/README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1-
# RelatedProductGraphQl
1+
# Magento_RelatedProductGraphQl module
22

3-
**RelatedProductGraphQl** provides endpoints for getting Cross Sell / Related/ Up Sell products data.
3+
This module provides endpoints for getting Cross Sell / Related/ Up Sell products data.
4+
5+
## Installation
6+
7+
This module does not introduce any database schema modifications or new data.
8+
9+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
10+
11+
## Extensibility
12+
13+
Extension developers can interact with the Magento_QuoteDownloadableLinks module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
14+
15+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_QuoteDownloadableLinks module.
16+
17+
## Additional information
18+
19+
You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql).

‎app/code/Magento/ReleaseNotification/README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,39 @@
11
# Magento_ReleaseNotification module
22

3-
The **Release Notification Module** serves to provide a notification delivery platform for displaying new features of a Magento installation or upgrade as well as any other required release notifications.
3+
This module serves to provide a notification delivery platform for displaying new features of a Magento installation or upgrade as well as any other required release notifications.
44

5-
## Purpose and Content
5+
## Installation
6+
7+
The Magento_ReleaseNotification module creates the `release_notification_viewer_log` table in the database.
8+
9+
All database schema changes made by this module are rolled back when the module gets disabled and setup:upgrade command is run.
10+
11+
For information about a module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
12+
13+
## Extensibility
14+
15+
Extension developers can interact with the Magento_ReleaseNotification module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
16+
17+
[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_ReleaseNotification module.
18+
19+
### UI components
20+
21+
You can extend release notification updates using the configuration files located in the `view/adminhtml/ui_component` directory:
22+
- `release_notification`
23+
24+
For information about a UI component in Magento 2, see [Overview of UI components](http://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html).
25+
26+
## Additional information
27+
28+
### Purpose and Content
629

730
* Provides a method of notifying administrators of changes, features, and functionality being introduced in a Magento release.
831
* Displays a modal containing a high level overview of the features included in the installed or upgraded release of Magento upon the initial login of each administrator into the Admin Panel for a given Magento version.
932
* The modal is enabled with pagination functionality to allow for easy navigation between each modal page.
1033
* Each modal page includes detailed information about a highlighted feature of the Magento release or other notification.
1134
* Release Notification modal content is determined and provided by Magento Marketing.
1235

13-
## Content Retrieval
36+
### Content Retrieval
1437

1538
Release notification content is maintained by Magento for each Magento version, edition, and locale. To retrieve the content, a response is returned from a request with the following parameters:
1639

@@ -26,7 +49,7 @@ The module will make three attempts to retrieve content for the parameters in th
2649

2750
If there is no content to be retrieved after these requests, the release notification modal will not be displayed to the admin user.
2851

29-
## Content Guidelines
52+
### Content Guidelines
3053

3154
The modal system in the ReleaseNotification module can have up to four modal pages. The admin user can navigate between pages using the "< Prev" and "Next >" buttons at the bottom of the modal. The last modal page will have a "Done" button that will close the modal and record that the admin user has seen the notification.
3255

@@ -48,6 +71,6 @@ The Sub Heading section is ideally used on the first modal page as a way to desc
4871

4972
A clickable link to internal or external content in any text field will be created by using the following format and opened in a new browser tab. Providing the URL for the link followed by the text to be displayed for that link in brackets will cause a clickable link to be created. The text between the brackets [text] will be the text that the clickable link shows.
5073

51-
### Link Format Example:
74+
#### Link Format Example:
5275

5376
The text: `https://devdocs.magento.com/ [Magento DevDocs].` will appear as [Magento DevDocs](https://devdocs.magento.com/).

0 commit comments

Comments
 (0)