Skip to content

Update alt text guidelines

Ashraf Khamis requested to merge alt-text-guidelines into master

What does this MR do and why?

This MR attempts to address some inconsistencies with the alt text guidelines. The example A runner sending a request to the Docker API. is not a complete sentence, yet it ends in punctuation. Should we include end punctuation regardless of whether we use a phrase or a complete sentence?

For context, see !167523 (merged). That MR has three phrases with no end punctuation (as I thought would be expected). Would you suggest changes to that text? Also, would you say that the text describes the context or content of those images? Sometimes it's not so straightforward to distinguish between the two.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

Edited by Ashraf Khamis

Merge request reports