Skip to content

Docs: Add image guidance to Style Guide

Craig Norris requested to merge docs-add-image-guidance-style-guide into master

What does this MR do?

This MR updates the Documentation Style Guide to provide more information about images, including how to create them and when to create them. The expectation is that we'll continue to refine this information over time, but this MR broaches the subject about image composition, and makes discrete sections for creating, saving, and using the image in product documentation.

Related issues

Author's checklist (required)

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

  • Optional: 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.

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