Skip to content

Commit c574c8e

Browse files
magento-engcom-teammagento-engcom-team
committed
ENGCOM-9353: [ReadMe] updated readMe file for GraphQl-GroupedProductGraphQl modules #31810
- Merge Pull Request #31810 from vlmed/magento2:update_readme_graphQL_grouped-product-graphQl - Merged commits: 1. f71b4bc
2 parents 926b334 + f71b4bc commit c574c8e

File tree

6 files changed

+207
-9
lines changed

6 files changed

+207
-9
lines changed

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

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
1-
# GraphQl
1+
# Magento_GraphQl module
22

3-
**GraphQl** provides the framework for the application to expose GraphQL compliant web services. It exposes an area for
3+
This module provides the framework for the application to expose GraphQL compliant web services. It exposes an area for
44
GraphQL services and resolves request data based on the generated schema. It also maps this response to a JSON object
55
for the client to read.
6+
7+
## Installation
8+
9+
The Magento_GraphQl module is one of the base Magento 2 modules. You cannot disable or uninstall this module.
10+
11+
This module is dependent on the following modules:
12+
- `Magento_Authorization`
13+
- `Magento_Eav`
14+
15+
The following modules depend on this module:
16+
- `Magento_BundleGraphQl`
17+
- `Magento_CatalogGraphQl`
18+
- `Magento_CmsGraphQl`
19+
- `Magento_CompareListGraphQl`
20+
- `Magento_ConfigurableProductGraphQl`
21+
- `Magento_DownloadableGraphQl`
22+
- `Magento_EavGraphQl`
23+
- `Magento_GraphQlCache`
24+
- `Magento_GroupedProductGraphQl`
25+
- `Magento_ReviewGraphQl`
26+
- `Magento_StoreGraphQl`
27+
28+
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).
29+
30+
## Extensibility
31+
32+
Extension developers can interact with the Magento_GraphQl module. For more information about the Magento extension mechanism, see [Magento plugins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
33+
34+
[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_GraphQl module.
35+
36+
## Additional information
37+
38+
You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql).

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

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
1-
# GraphQl Cache
1+
# Magento_GraphQlCache module
22

3-
**GraphQL Cache** provides the ability to cache GraphQL queries.
4-
This module allows Magento's built-in cache or Varnish as the application for serving the Full Page Cache to the front end.
3+
This module provides the ability to cache GraphQL queries.
4+
This module allows Magento built-in cache or Varnish as the application for serving the Full Page Cache to the front end.
5+
6+
## Installation
7+
8+
Before installing this module, note that the Magento_GraphQlCache module is dependent on the following modules:
9+
10+
- `Magento_PageCache`
11+
- `Magento_GraphQl`
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_GraphQlCache module. For more information about the Magento extension mechanism, see [Magento plugins](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_GraphQlCache module.
20+
21+
## Additional information
22+
23+
- [Learn more about GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql).
24+
- [Learn more about GraphQl Caching In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql/caching.html).

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

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,18 @@
1-
Magento_GroupedCatalogInventory contains behavior related to the inventory status of items within grouped products.
1+
# Magento_GroupedCatalogInventory module
2+
3+
This module contains behavior related to the inventory status of items within grouped products.
4+
5+
## Installation
6+
7+
Before installing this module, note that the Magento_GroupedCatalogInventory module is dependent on the following modules:
8+
9+
- `Magento_Catalog`
10+
- `Magento_GroupedProduct`
11+
12+
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).
13+
14+
## Extensibility
15+
16+
Extension developers can interact with the Magento_GroupedCatalogInventory module. For more information about the Magento extension mechanism, see [Magento plugins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
17+
18+
[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_GroupedCatalogInventory module.

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Magento_GroupedImportExport module
2+
3+
This module implements Grouped products import/export functionality.
4+
This module is designed to extend existing functionality of Magento_CatalogImportExport module by adding new product type.
5+
6+
## Installation
7+
8+
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).
9+
10+
## Extensibility
11+
12+
Extension developers can interact with the Magento_GroupedImportExport module. For more information about the Magento extension mechanism, see [Magento plugins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
13+
14+
[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_GroupedImportExport module.
15+
16+
## Additional information
17+
18+
You can get more information about import/export processes in magento at the articles:
19+
- [Import](https://docs.magento.com/user-guide/system/data-import.html)
20+
- [Export](https://docs.magento.com/user-guide/system/data-export.html)

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

Lines changed: 89 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,93 @@
1-
Magento_GroupedProduct module provides ability to offer several standalone products for sale as a group on the same Product Detail page.
1+
# Magento_GroupedProduct module
2+
3+
This module introduces new product type in the Magento application named Grouped Product.
4+
It provides ability to offer several standalone products for sale as a group on the same Product Detail page.
25
It can offer variations of a product, or group them by season or theme to create a coordinated set.
36
Products can be purchased separately or as a set.
47
Each product purchased appears in the Shopping Cart as a separate item.
8+
59
This module extends the existing functionality of Magento_Catalog module by adding new product type.
10+
11+
## Installation details
12+
13+
Before installing this module, note that the Magento_GroupedProduct module is dependent on the following modules:
14+
- `Magento_Catalog`
15+
- `Magento_CatalogInventory`
16+
- `Magento_Sales`
17+
- `Magento_Quote`
18+
19+
Before disabling or uninstalling this module, note that the following modules depends on this module:
20+
- `Magento_GroupedCatalogInventory`
21+
- `Magento_GroupedProductGraphQl`
22+
- `Magento_MsrpGroupedProduct`
23+
24+
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).
25+
26+
## Structure
27+
28+
`Pricing/` - the directory that contains solutions for grouped product price.
29+
30+
For information about a typical file structure of a module in Magento 2, see [Module file structure](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).
31+
32+
## Extensibility
33+
34+
Extension developers can interact with the Magento_GroupedProduct module. For more information about the Magento extension mechanism, see [Magento plugins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
35+
36+
[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_GroupedProduct module.
37+
38+
### Layouts
39+
40+
This module introduces the following layouts in the `view/frontend/layout`, `view/adminhtml/layout` and `view/base/layout` directories:
41+
- `view/adminhtml/layout`:
42+
- `catalog_product_grouped`
43+
- `catalog_product_new`
44+
- `catalog_product_view_type_grouped`
45+
- `groupedproduct_edit_popup`
46+
- `groupedproduct_popup_grid`
47+
- `sales_order_creditmemo_new`
48+
- `sales_order_creditmemo_updateqty`
49+
- `sales_order_creditmemo_view`
50+
- `sales_order_invoice_new`
51+
- `sales_order_invoice_updateqty`
52+
- `sales_order_invoice_view`
53+
- `sales_order_view`
54+
- `view/frontend/layout`:
55+
- `catalog_product_rss_feed_renderer_list`
56+
- `catalog_product_view_type_grouped`
57+
- `checkout_cart_item_renderers`
58+
- `checkout_onepage_review_item_renderers`
59+
- `sales_email_order_creditmemo_renderers`
60+
- `sales_email_order_invoice_renderers`
61+
- `sales_email_order_renderers`
62+
- `sales_guest_invoice`
63+
- `sales_order_creditmemo_renderers`
64+
- `sales_order_invoice_renderers`
65+
- `sales_order_item_renderers`
66+
- `sales_order_print_creditmemo_renderers`
67+
- `sales_order_print_renderers`
68+
- `view/base/layout`:
69+
- `catalog_product_prices`
70+
71+
For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).
72+
73+
### UI components
74+
75+
You can extend a grouped product listing updates using the configuration files located in the `view/adminhtml/ui_component` directory:
76+
- `grouped_product_listing`
77+
78+
This module extends widgets ui components the configuration files located in the `view/frontend/ui_component` directory:
79+
- `widget_recently_compared`
80+
- `widget_recently_viewed`
81+
82+
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).
83+
84+
### Public APIs
85+
86+
- `\Magento\GroupedProduct\Api\Data\GroupedOptionsInterface`
87+
- represents `product item id with qty` of a grouped product
88+
89+
For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html).
90+
91+
## Additional information
92+
93+
For more information about creating grouped product, see [Creating Grouped Product](https://docs.magento.com/user-guide/catalog/product-create-grouped.html).

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

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
1-
# GroupedProductGraphQl
1+
# Magento_GroupedProductGraphQl module
22

3-
**GroupedProductGraphQl** provides type and resolver information for the GraphQl module
3+
This module provides type and resolver information for the GraphQl module
44
to generate grouped product information.
5+
6+
## Installation
7+
8+
Before installing this module, note that the Magento_GroupedProductGraphQl is dependent on the following modules:
9+
10+
- `Magento_GroupedProduct`
11+
- `Magento_GraphQl`
12+
- `Magento_CatalogGraphQlr`
13+
14+
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).
15+
16+
## Extensibility
17+
18+
Extension developers can interact with the Magento_GroupedProductGraphQll module. For more information about the Magento extension mechanism, see [Magento plugins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
19+
20+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_GroupedProductGraphQl module.
21+
22+
## Additional information
23+
24+
You can get more information about [GraphQl In Magento 2](https://devdocs.magento.com/guides/v2.4/graphql).

0 commit comments

Comments
 (0)