Skip to content

Update images with clearer versions

Marcel Amirault requested to merge docs-image-tweak into master

What does this MR do?

As part of thinking about what limits we should put on images, and what automation we can test, I created this MR to follow up on the changes in !47696 (merged).

While avoiding screenshots in general is preferable, and keeping images as small as possible is important, I worry that being too strict on this will reduce the overall quality of the docs. Several of the images we resized or cropped ended up being very blurry, and do not render well on the docs site.

This raises some questions for our style guide, I think:

  • What should we focus on?
    • File size?
    • Dimensions?
    • Both?
  • What should be their limits?
    • If an image falls under the size limit, do we have to worry about the dimensions as much?
    • Are we going to be reducing the image quality unnecessarily?

Related issues

Related to #281048

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.
Edited by Marcel Amirault

Merge request reports