ENGCOM-9026: [ReadMe] updated readMe file for Persistent-QuoteAnalitics #32356

Author: gabrieldagama

app/code/Magento/Persistent/README.md

@@ -1,5 +1,61 @@
-Magento\Persistent module enables set customer a long-term cookie containing internal id (random hash - to exclude brute
-force) of persistent session. Persistent session data is kept in DB - so it's not deleted in some days and is kept for
+# Magento_Persistent module
+
+This module enables setting a long-term cookie containing internal id (random hash - to exclude brute
+force) of persistent session for customer. Persistent session data is kept in DB - so it's not deleted in some days and is kept for
 as much time as we need. DB session keeps customerId + some data from real customer session that we want to sync (e.g.
 num items in shopping cart). For registered customer this info is synced to persistent session if choose "Remember me"
 checkbox during first login.
+
+## Installation
+
+Before installing this module, note that the Magento_Persistent is dependent on the following modules:
+- `Magento_Checkout`
+- `Magento_PageCache`
+
+The Magento_Persistent module creates the `persistent_session` table in the database.
+
+This module modifies the following tables in the database:
+- `quote` - adds column `is_persistent`
+
+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_Persistent 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_Persistent module.
+
+A lot of functionality in the module is on JavaScript, use [mixins](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/js_mixins.html) to extend it.
+
+### Events
+
+The module dispatches the following events:
+
+#### Controller
+
+- `persistent_session_expired` event in the `\Magento\Persistent\Controller\Index\UnsetCookie::execute` method
+
+#### Observer
+
+- `persistent_session_expired` event in the `\Magento\Persistent\Observer\CheckExpirePersistentQuoteObserver::execute` method
+
+For information about an event in Magento 2, see [Events and observers](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events).
+
+### Layouts
+
+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).
+
+## Additional information
+
+More information can get at articles:
+- [Persistent Shopping Cart](https://docs.magento.com/user-guide/configuration/customers/persistent-shopping-cart.html)
+- [Persistent Cart](https://docs.magento.com/user-guide/sales/cart-persistent.html)
+
+### Cron options
+
+Cron group configuration can be set at `etc/crontab.xml`:
+- `persistent_clear_expired` - clear expired persistent sessions
+
+[Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html).

app/code/Magento/ProductAlert/README.md

@@ -1 +1,47 @@
-The Magento_ProductAlert module enables product alerts, which allow customers to sign up for emails about product price or stock status change.
+# Magento_ProductAlert module
+
+This module enables product alerts, which allow customers to sign up for emails about product price or stock status change.
+
+## Installation
+
+Before installing this module, note that the Magento_ProductAlert is dependent on the following modules:
+- `Magento_Catalog`
+- `Magento_Customer`
+
+The Magento_ProductAlert module creates the following tables in the database:
+- `product_alert_price`
+- `product_alert_stock`
+
+All database schema changes made by this module are rolled back when the module gets disabled and setup:upgrade command is run.
+
+The Magento_ProductAlert module contains the recurring script. Script's modifications don't need to be manually reverted upon uninstallation. 
+
+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_ProductAlert 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_ProductAlert module.
+
+### Layouts
+
+This module introduces the following layouts in the `view/frontend/layout` directory:
+- `catalog_product_view`
+- `productalert_unsubscribe_email`
+
+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).
+
+## Additional information
+
+More information can get at articles:
+- [Product Alerts](https://docs.magento.com/user-guide/catalog/inventory-product-alerts.html)
+- [Product Alert Run Settings](https://docs.magento.com/user-guide/catalog/inventory-product-alert-run-settings.html)
+
+### Cron options
+
+Cron group configuration can be set at `etc/crontab.xml`:
+- `catalog_product_alert` - send product alerts to customers
+
+[Learn how to configure and run cron in Magento.](http://devdocs.magento.com/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html).
+

app/code/Magento/ProductVideo/README.md

@@ -1 +1,46 @@
-The Magento_ProductVideo module implements functionality related with linking video files from external resources to product.
+# Magento_ProductVideo module
+
+This module implements functionality related with linking video files from external resources to product.
+
+## Installation
+
+Before installing this module, note that the Magento_ProductAlert is dependent on the following modules:
+- `Magento_Catalog`
+- `Magento_Backend`
+
+The Magento_ProductVideo module creates the `catalog_product_entity_media_gallery_value_video` 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_ProductVideo 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_ProductVideo module.
+
+A lot of functionality in the module is on JavaScript, use [mixins](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/js_mixins.html) to extend it.
+
+### Layouts
+
+This module introduces the following layouts in the `view/frontend/layout` and `view/adminhtml/layout` directories:
+- `view/adminhtml/layout`
+    - `catalog_product_new`
+- `view/frontend/layout`
+    - `catalog_product_view`
+
+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).
+
+### UI components
+
+This module extends following ui components located in the `view/adminhtml/ui_component` directory:
+- `product_form`
+
+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
+
+More information can get at articles:
+- [Learn how to add Product Video](https://docs.magento.com/user-guide/catalog/product-video.html)
+- [Learn how to configure Product Video](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/themes/product-video.html)