You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
second, the compress images action is great in optimizing the compression of a given image, but if the dimensions of the image is too large, the compression doesn't help, we miss an opportunity to reduce the dimensions of the image to drastically reduce the size of the file
third, the "bonita getting started" pages contains very large gif to show animated contents to the readers. The contents should be a video and served with the appropriate format and provider (YouTube, ....). The GIF format is inaccurate for such purpose. See The bonita-doc branches store too large gif files #788
So, I suggest we restrict the usage of large file by adding a new step in the "Contribution check" action. We could also forbid the usage of GIF content, even JPG if we want to favor PNG or Webm files.
The maximum allowed size is to defined.
Prior applying this check, we should review images in all content repositories and fix large images:
add the check in the "contribution checks" workflow. First ignore the gif images and decide the max size that will be allowed. 300kB seems enough. To be discussed
add a check to detect images that have too large dimensions (values to be discussed). This could be done with the identify cli provided by imagemagick (https://unix.stackexchange.com/a/279911)
document the commands used to detect file names of too large images,
resize images in content repositories
bcd? this repository is no longer updated and there are probably a few images to be resized. We could therefore ignore it.
bonita
bpi
central
cloud
labs
test-toolkit
Available tools for image resizing
Plenty exists, so we will probably use a mix of script/tool/extensions depending on the situation and the amount of files to resize.
tbouffard
changed the title
Add a warning if an image is big in "Contribution check" action
"Contribution check" action: add a warning if an image size is too large
Sep 25, 2024
NOTE: this is a new attempt after #434 has been closed.
#434 (comment) mentions that it was decided to use an action to compress images. But this is not enough
bonita-doc
repository, to extend to other content repositories, implement Apply the "images compression" workflow to doc content repositories without duplication #498So, I suggest we restrict the usage of large file by adding a new step in the "Contribution check" action. We could also forbid the usage of GIF content, even JPG if we want to favor PNG or Webm files.
The maximum allowed size is to defined.
Prior applying this check, we should review images in all content repositories and fix large images:
Tasks
Available tools for image resizing
Plenty exists, so we will probably use a mix of script/tool/extensions depending on the situation and the amount of files to resize.
In the Antora context, a comment in the Zulip chat suggests to use https://github.com/GoogleChromeLabs/squoosh
The text was updated successfully, but these errors were encountered: