Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit dfed337

Browse files
Added Media Gallery Image Optimization Documenation (#762)
* Added Media Gallery Image Optimization Documentation Co-authored-by: Leslie Tilling <[email protected]>
1 parent 1fe85e9 commit dfed337

File tree

5 files changed

+39
-2
lines changed

5 files changed

+39
-2
lines changed

src/_data/toc/content.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ pages:
5252
url: "/cms/media-gallery-asset-management.html"
5353
- label: Folder Management
5454
url: "/cms/media-gallery-folder-management.html"
55+
- label: Media Gallery Image Optimization
56+
url: "/cms/media-gallery-image-optimization.html"
5557
- label: Using the Editor
5658
url: "/cms/editor.html"
5759
children:
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Media Gallery Image Optimization
3+
---
4+
5+
The new [Media Gallery]({% link cms/media-gallery.md %}) provides an _Image Optimization_ feature, which improves performance and decreases media file sizes on the storefront. This optimization is enabled by default and can be modified in the store configuration settings.
6+
7+
## Configure image optimization
8+
9+
1. On the _Admin_ sidebar, go to **Stores** > _Settings_ > **Configuration**.
10+
11+
1. In the left panel, expand **Advanced** and choose **System**.
12+
13+
1. Expand ![Expansion selector]({% link images/images/btn-expand.png %}) **Media Gallery Image Optimization** and do the following:
14+
15+
- Set **Enable Image Optimization** to `Yes`.
16+
- Enter the **Maximum Width** and **Maximum Height** values (in pixels) according to your needs..
17+
18+
## Behaviour
19+
20+
When Media Gallery Image Optimization functionality is enabled, an optimized copy of an image is automatically inserted in the content from the [Media Gallery]({% link cms/media-gallery.md %}) instead of the original file.
21+
22+
Any time the _Maximum Width_ and _Maximum Heigh_ values are changed in the configuration, it updates all the existing optimized images that were previously inserted.
23+
24+
The Media Gallery Image Optimization requires `media.gallery.renditions.update` queue consumers to be running for regenerating optimized image when configuration is changed. See [Manage message queues](https://devdocs.magento.com/guides/v2.4/config-guide/mq/manage-message-queues.html) documentation for more details.

src/cms/media-gallery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ To access the new Media Gallery when you are adding or editing a page:
5454
[add-page]: {% link cms/page-add.md %}
5555
[create-category]: {% link catalog/category-create.md %}
5656
[editor-insert-image]: {% link cms/editor-insert-image.md %}
57-
[editor-config]: {% link cms/editor-configure.md %}
57+
[editor-config]: {% link cms/editor-configure.md %}

src/configuration/advanced/system.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,5 +214,16 @@ _Enhanced Media Gallery_
214214
|--- |--- |--- |
215215
|Enabled|Global|Enables or disables the new Media Gallery.|
216216

217+
## Media Gallery Image Optimization
218+
219+
![Advanced configuration - Media Gallery Image Optimization]({% link images/images/enhanced-media-gallery/system-image-optimization.png %}){: .zoom}
220+
_Media Gallery Image Optimization_
221+
222+
|Field|[Scope]({% link configuration/scope.md %})|Description|
223+
|--- |--- |--- |
224+
|Enable Image Optimization|Global|Determines if images are resized to decrease the file size of the images inserted to the content. Original images are preserved in the Media Gallery.|
225+
|Maximum Width|Global|The maximum width (in pixels) for images inserted from Media Gallery into the content.|
226+
|Maximum Height|Global|The maximum height (in pixels) for images inserted from Media Gallery into the content.|
227+
217228
[1]: https://en.wikipedia.org/wiki/Sendmail
218-
[2]: https://magento.com/security/news/new-zend-framework-1-security-vulnerability
229+
[2]: https://magento.com/security/news/new-zend-framework-1-security-vulnerability
Loading

0 commit comments

Comments
 (0)