ENGCOM-9229: [ReadMe] updated readMe file for MediaGallery-MediaStorage modules #31894

 - Merge Pull Request #31894 from vlmed/magento2:update_readme_nedia-gallery_media-storage
 - Merged commits:
   1. a1f384c

Author: magento-engcom-team

app/code/Magento/MediaGallery/README.md

@@ -20,4 +20,6 @@ Extension developers can interact with the Magento_MediaGallery module. For more
 
 ## Additional information
 
-For information about significant changes in patch releases, see [Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).
+For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).
+
+[Learn more about New Media Gallery](https://docs.magento.com/user-guide/cms/media-gallery.html).

app/code/Magento/MediaGalleryApi/README.md

@@ -2,12 +2,59 @@
 
 The Magento_MediaGalleryApi module serves as application program interface (API) responsible for storing and managing media gallery asset attributes.
 
+## Installation details
+
+For information about 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_MediaGallery 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).
+Extension developers can interact with the Magento_MediaGalleryApi 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_MediaGalleryApi module.
 
+### Public APIs
+
+- `\Magento\MediaGalleryApi\Api\Data\AssetInterface`
+    - media asset entity data
+
+- `\Magento\MediaGalleryApi\Api\Data\AssetKeywordsInterface`
+    - assets keywords aggregation
+
+- `\Magento\MediaGalleryApi\Api\Data\AssetKeywordsInterface`
+    - media asset keyword entity data
+
+- `\Magento\MediaGalleryApi\Api\CreateDirectoriesByPathsInterface`:
+    - create new directories by provided paths
+
+- `\Magento\MediaGalleryApi\Api\DeleteAssetsByPathsInterface`:
+    - delete media assets by paths. Removes all the assets which paths start with provided paths
+
+- `\Magento\MediaGalleryApi\Api\DeleteDirectoriesByPathsInterface`:
+    - delete folders by provided paths
+
+- `\Magento\MediaGalleryApi\Api\GetAssetsByIdsInterface`:
+    - get media gallery assets by id attribute
+    
+- `\Magento\MediaGalleryApi\Api\GetAssetsByPathsInterface`:
+    - get media gallery assets by paths in media storage
+
+- `\Magento\MediaGalleryApi\Api\GetAssetsKeywordsInterface`:
+    - get a media gallery asset keywords related to media gallery asset ids provided
+
+- `\Magento\MediaGalleryApi\Api\IsPathExcludedInterface`:
+    - check if the path is excluded from displaying and processing in the media gallery
+
+- `\Magento\MediaGalleryApi\Api\SaveAssetsInterface`:
+    - save media gallery assets to the database
+
+- `\Magento\MediaGalleryApi\Api\SaveAssetsKeywordsInterface`:
+    - save keywords related to assets to the database
+  
+- `\Magento\MediaGalleryApi\Api\SearchAssetsInterface`:
+    - search media gallery assets
+
+For information about a public API in Magento 2, see [Public interfaces & APIs](http://devdocs.magento.com/guides/v2./extension-dev-guide/api-concepts.html).
+
 ## Additional information
 
-For information about significant changes in patch releases, see [Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).
+For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).

app/code/Magento/MediaGalleryCatalog/README.md

@@ -8,9 +8,9 @@ For information about module installation in Magento 2, see [Enable or disable m
 
 ## Extensibility
 
-Extension developers can interact with the Magento_MediaGallery 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).
+Extension developers can interact with the Magento_MediaGalleryCatalog 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_MediaGallery module.
+[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_MediaGalleryCatalog module.
 
 ## Additional information
 

app/code/Magento/MediaGalleryCatalogIntegration/README.md

@@ -1,3 +1,11 @@
-# Magento_MediaGalleryCatalogIntegration
+# Magento_MediaGalleryCatalogIntegration module
 
-The purpose of this module is for extending catalog image uploader functionality.
+This module extends catalog image uploader functionality.
+
+## Installation
+
+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
+
+[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_MediaGalleryCatalogIntegration module.

app/code/Magento/MediaGalleryCatalogUi/README.md

@@ -2,12 +2,36 @@
 
 The Magento_MediaGalleryCatalogUi module that implement category grid for media gallery.
 
+## Installation details
+
+For information about 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_MediaGalleryRenditions 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).
+Extension developers can interact with the Magento_MediaGalleryCatalogUi 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_MediaGalleryCatalogUi module.
+
+### Layouts
+
+This module introduces the following layouts in the `view/adminhtml/layout` directory:
+- `media_gallery_catalog_category_index`
+
+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
+
+The configuration files located in the directory `view/adminhtml/ui_component`.
+
+You can extend media gallery listing updates using the following configuration files:
+- `media_gallery_category_listing`
+
+This module extends ui components:
+- `media_gallery_listing`
+- `standalone_media_gallery_listing`
 
-[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_MediaGalleryRenditions module.
+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
 
-For information about significant changes in patch releases, see [Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).
+For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).

app/code/Magento/MediaGalleryCmsUi/README.md

@@ -2,12 +2,26 @@
 
 The Magento_MediaGalleryCmsUi module provides Magento_Cms related UI elements to the media gallery user interface
 
+## Installation details
+
+For information about 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_MediaGalleryRenditions 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).
+Extension developers can interact with the Magento_MediaGalleryCmsUi 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_MediaGalleryCmsUi module.
+
+### UI components
+
+The configuration files located in the directory `view/adminhtml/ui_component`.
+
+This module extends ui components:
+- `media_gallery_listing`
+- `standalone_media_gallery_listing`
 
-[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_MediaGalleryRenditions module.
+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
 
-For information about significant changes in patch releases, see [Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).
+For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).

app/code/Magento/MediaGalleryIntegration/README.md

@@ -1,3 +1,16 @@
-# Magento_MediaGalleryIntegration
+# Magento_MediaGalleryIntegration module
 
 The purpose of this module is to keep the integration of enhanced media gallery to Magento separated from implementation.
+
+## Installation details
+
+Before installing this module, note that the Magento_MediaGalleryIntegration is dependent on the Magento_Ui module.
+For information about 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
+
+[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_MediaGalleryIntegration module.
+
+## Additional information
+
+For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).

app/code/Magento/MediaGalleryMetadata/README.md

@@ -1,3 +1,13 @@
-# Magento_MediaGalleryMetadata
+# Magento_MediaGalleryMetadata module
 
 The purpose of this module is to provide an ability to extract the metadata from file and populating Media Asset entity fields when an image is uploaded to Magento and also provide an ability to update the metadata stored in an image file.
+
+## Installation details
+
+For information about 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_MediaGalleryMetadata 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_MediaGalleryMetadata module.

app/code/Magento/MediaGalleryMetadataApi/README.md

@@ -1,3 +1,13 @@
-# Magento_MediaGalleryMetadataApi
+# Magento_MediaGalleryMetadataApi module
 
 The Magento_MediaGalleryMetadataApi module is responsible for the media gallery metadata implementation API.
+
+## Installation details
+
+For information about 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_MediaGalleryMetadataApi 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_MediaGalleryMetadataApi module.

app/code/Magento/MediaGalleryRenditions/README.md

@@ -1,6 +1,10 @@
 # Magento_MediaGalleryRenditions module
 
-The Magento_MediaGalleryRenditions module implements height and width fields for for media gallery items.
+The Magento_MediaGalleryRenditions module implements height and width fields for media gallery items.
+
+## Installation details
+
+For information about 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
 
@@ -10,4 +14,10 @@ Extension developers can interact with the Magento_MediaGalleryRenditions module
 
 ## Additional information
 
-For information about significant changes in patch releases, see [Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).
+For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).
+
+#### Message Queue Consumer
+
+- `media.gallery.renditions.update` - update renditions for given paths, if empty array is provided - all renditions are updated
+
+[Learn how to manage Message Queues](https://devdocs.magento.com/guides/v2.4/config-guide/mq/manage-message-queues.html).

app/code/Magento/MediaGalleryRenditionsApi/README.md

@@ -2,12 +2,10 @@
 
 The Magento_MediaGalleryRenditionsApi module is responsible for the API implementation of Media Gallery Renditions.
 
-## Extensibility
+## Installation details
 
-Extension developers can interact with the Magento_MediaGalleryRenditions 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_MediaGalleryRenditionsApi module.
+For information about 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).
 
 ## Additional information
 
-For information about significant changes in patch releases, see [Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).
+For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).

app/code/Magento/MediaGallerySynchronization/README.md

@@ -3,6 +3,10 @@
 The Magento_MediaGallerySynchronization module represents implementation of synchronization between data and objects contains
 media asset information.
 
+## Installation details
+
+For information about 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_MediaGallerySynchronization 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).
@@ -11,4 +15,14 @@ Extension developers can interact with the Magento_MediaGallerySynchronization m
 
 ## Additional information
 
-For information about significant changes in patch releases, see [Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).
+### Console commands
+
+- `bin/magento media-gallery:sync` - synchronize media storage and media assets in the database
+
+#### Message Queue Consumer
+
+- `media.gallery.synchronization` - run media files synchronization
+
+[Learn how to manage Message Queues](https://devdocs.magento.com/guides/v2.4/config-guide/mq/manage-message-queues.html).
+
+For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).

app/code/Magento/MediaGallerySynchronizationApi/README.md

@@ -10,4 +10,4 @@ Extension developers can interact with the Magento_MediaGallerySynchronizationAp
 
 ## Additional information
 
-For information about significant changes in patch releases, see [Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).
+For information about significant changes in patch releases, see [2.4.x Release information](https://devdocs.magento.com/guides/v2.4/release-notes/bk-release-notes.html).

app/code/Magento/MediaGallerySynchronizationMetadata/README.md

@@ -1,3 +1,13 @@
-# Magento_MediaGallerySynchronizationMetadata
+# Magento_MediaGallerySynchronizationMetadata module
 
-The purpose of this module is to include assets metadata to media gallery synchronization process
+The purpose of this module is to include assets metadata to media gallery synchronization process.
+
+## Installation details
+
+For information about 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_MediaGallerySynchronizationMetadata 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_MediaGallerySynchronizationMetadata module.