Skip to content

Compress images with pngquant

Amy Qualls requested to merge docs-aqualls-compress-images into master

What does this MR do?

As part of the monthly chore list for the technical writing team, I found the following uncompressed images:

[amyq] ~/dev/gitlab/gitlab (master) $ bundle exec rake pngquant:lint
Checking 1206 PNG files in doc/**
Uncompressed file detected: doc/development/img/each_batch_users_table_filtered_index_v13_7.png
Uncompressed file detected: doc/development/img/each_batch_users_table_good_index_v13_7.png
Uncompressed file detected: doc/development/img/each_batch_users_table_iteration_1_v13_7.png
Uncompressed file detected: doc/development/img/each_batch_users_table_iteration_4_v13_7.png
Uncompressed file detected: doc/development/img/each_batch_users_table_bad_index_v13_7.png
Uncompressed file detected: doc/development/img/each_batch_users_table_iteration_2_v13_7.png
Uncompressed file detected: doc/development/img/each_batch_users_table_iteration_5_v13_7.png
Uncompressed file detected: doc/development/img/each_batch_users_table_iteration_3_v13_7.png
Uncompressed file detected: doc/development/img/each_batch_users_table_v13_7.png
Uncompressed file detected: doc/development/img/each_batch_users_table_filter_v13_7.png
Uncompressed file detected: doc/development/integrations/img/copy_cookies.png
Uncompressed file detected: doc/development/integrations/img/copy_curl.png
Uncompressed file detected: doc/user/project/integrations/img/microsoft_teams_select_incoming_webhook.png
The 13 image(s) above have not been optimally compressed using pngquant.
Please run "bin/rake pngquant:compress" and commit the result.

This merge request compresses those images to save space.

Related issues

Related to technical-writing#307 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports

Loading