Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ReadMe] updated readMe file for QuoteBundleOptions-ReleaseNotification modules #33124

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions app/code/Magento/QuoteBundleOptions/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# QuoteBundleOptions
# Magento_QuoteBundleOptions module

**QuoteBundleOptions** provides data provider for creating buy request for bundle products.
This module provides data provider for creating buy request for bundle products.

## Installation

This module does not introduce any database schema modifications or new data.

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).

## Extensibility

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).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question - on DevDocs & Knowledge Base use of "Magento" is being switched to "Adobe Commerce" - should we not be doing this on these new README.md now, rather than later?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should leave a Magento as in the Readme template https://github.com/magento/devdocs/wiki/Magento-module-README.md provided by Magento.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accepted!


[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.
16 changes: 14 additions & 2 deletions app/code/Magento/QuoteConfigurableOptions/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# QuoteConfigurableOptions
# Magento_QuoteConfigurableOptions module

**QuoteConfigurableOptions** provides data provider for creating buy request for configurable products.
This module provides data provider for creating buy request for configurable products.

## Installation

This module does not introduce any database schema modifications or new data.

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).

## Extensibility

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).

[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.
16 changes: 14 additions & 2 deletions app/code/Magento/QuoteDownloadableLinks/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# QuoteDownloadableLinks
# Magento_QuoteDownloadableLinks module

**QuoteDownloadableLinks** provides data provider for creating buy request for links of downloadable products.
This module provides data provider for creating buy request for links of downloadable products.

## Installation

This module does not introduce any database schema modifications or new data.

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).

## Extensibility

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).

[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.
82 changes: 80 additions & 2 deletions app/code/Magento/QuoteGraphQl/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,82 @@
# QuoteGraphQl
# Magento_QuoteGraphQl module

**QuoteGraphQl** provides type and resolver information for the GraphQl module
This module provides type and resolver information for the GraphQl module
to generate quote (cart) information endpoints. Also provides endpoints for modifying a quote.

## Installation

Before installing this module, note that the Magento_QuoteGraphQl is dependent on the following modules:
- `Magento_CatalogGraphQl`

This module does not introduce any database schema modifications or new data.

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).

## Extensibility

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).

[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.

## Additional information

You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql).

### GraphQl Query

- `cart` query - retrieve information about a particular cart.
[Learn more about cart query](https://devdocs.magento.com/guides/v2.4/graphql/queries/cart.html).

- `customerCart` query - returns the active cart for the logged-in customer. If the cart does not exist, the query creates one.
[Learn more about customerCart query](https://devdocs.magento.com/guides/v2.4/graphql/queries/customer-cart.html).

### GraphQl Mutation

- `createEmptyCart` mutation - creates an empty shopping cart for a guest or logged in customer.
[Learn more about createEmptyCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/create-empty-cart.html).

- `addSimpleProductsToCart` mutation - allows you to add any number of simple and group products to the cart at the same time.
[Learn more about addSimpleProductsToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/add-simple-products.html).

- `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.
[Learn more about addVirtualProductsToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/add-virtual-products.html).

- `applyCouponToCart` mutation - applies a pre-defined coupon code to the specified cart.
[Learn more about applyCouponToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/apply-coupon.html).

- `removeCouponFromCart` mutation - removes a previously-applied coupon from the cart.
[Learn more about removeCouponFromCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/remove-coupon.html).

- `updateCartItems` mutation - allows you to modify items in the specified cart.
[Learn more about updateCartItems mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/update-cart-items.html).

- `removeItemFromCart` mutation - deletes the entire quantity of a specified item from the cart.
[Learn more about removeItemFromCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/remove-item.html).

- `setShippingAddressesOnCart` mutation - sets one or more shipping addresses on a specific cart.
[Learn more about setShippingAddressesOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-shipping-address.html).

- `setBillingAddressOnCart` mutation - sets the billing address for a specific cart.
[Learn more about setBillingAddressOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-billing-address.html).

- `setShippingMethodsOnCart` mutation - sets one or more delivery methods on a cart.
[Learn more about setShippingMethodsOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-shipping-method.html).

- `setPaymentMethodOnCart` mutation - defines which payment method to apply to the cart.
[Learn more about setPaymentMethodOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-payment-method.html).

- `setGuestEmailOnCart` mutation - assigns email to the guest cart.
[Learn more about setGuestEmailOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-guest-email.html).

- `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://devdocs.magento.com/guides/v2.4/graphql/mutations/set-payment-place-order.html).

- `mergeCarts` mutation - transfers the contents of a guest cart into the cart of a logged-in customer.
[Learn more about mergeCarts mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/merge-carts.html).

- `placeOrder` mutation - converts the cart into an order and returns an order ID.
[Learn more about placeOrder mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/place-order.html).

- `addProductsToCart` mutation - adds any type of product to the shopping cart.
[Learn more about addProductsToCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/add-products-to-cart.html).

20 changes: 18 additions & 2 deletions app/code/Magento/RelatedProductGraphQl/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# RelatedProductGraphQl
# Magento_RelatedProductGraphQl module

**RelatedProductGraphQl** provides endpoints for getting Cross Sell / Related/ Up Sell products data.
This module provides endpoints for getting Cross Sell / Related/ Up Sell products data.

## Installation

This module does not introduce any database schema modifications or new data.

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).

## Extensibility

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).

[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.

## Additional information

You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql).
33 changes: 28 additions & 5 deletions app/code/Magento/ReleaseNotification/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,39 @@
# Magento_ReleaseNotification module

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.
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.

## Purpose and Content
## Installation

The Magento_ReleaseNotification module creates the `release_notification_viewer_log` table in the database.

All database schema changes made by this module are rolled back when the module gets disabled and setup:upgrade command is run.

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).

## Extensibility

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).

[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.

### UI components

You can extend release notification updates using the configuration files located in the `view/adminhtml/ui_component` directory:
- `release_notification`

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).

## Additional information

### Purpose and Content

* Provides a method of notifying administrators of changes, features, and functionality being introduced in a Magento release.
* 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.
* The modal is enabled with pagination functionality to allow for easy navigation between each modal page.
* Each modal page includes detailed information about a highlighted feature of the Magento release or other notification.
* Release Notification modal content is determined and provided by Magento Marketing.

## Content Retrieval
### Content Retrieval

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:

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

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

## Content Guidelines
### Content Guidelines

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.

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

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.

### Link Format Example:
#### Link Format Example:

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