Skip to content

Update alt text for images

❗ COMMUNITY CONTRIBUTORS, PLEASE ONLY PICKUP ONE DOC/FILE TO ALLOW OTHER NEW CONTRIBUTORS TO LEARN FROM THESE TOO ❗

This issue is to improve the alt text for images in the GitLab documentation.

Implementation plan

To contribute to this issue:

  1. Familiarize yourself with style guidance for writing alt text.
  2. Open this spreadsheet.
  3. Put your username next to the alt text you want to review.
    • All of the files are in the doc folder in the GitLab repo.
    • Assign yourself no more than three doc files. Many people want to contribute, so we'd like everyone to have an opportunity.
  4. Open a merge request to update any alt text that doesn't follow the guidelines. For details with how to open a merge request, see Contribute to the GitLab documentation.
    • In the merge request description, include this text: Related to: https://gitlab.com/gitlab-org/gitlab/-/issues/479161

Thank you in advance for your contribution!

Alt text examples

Examples of helpful alt text:

  • ![The user impersonation button.](img/impersonate_user_button_v13_8.png)
  • ![The user permission export button.](img/export_permissions_v13_11.png)
  • ![An audit event with an impersonated user.](img/impersonated_audit_events_v15_7.png)

Examples of alt text that can be improved:

  • ![Alt text](img/rich_text_editor_02_v16_2.png)
  • ![Alt text](img/rich_text_editor_03_v16_2.png)
  • ![scan_results_example_bot_message_v17_0](img/scan_result_policy_example_bot_message_vulnerabilities_v17_0.png)
  • ![scan_results_example_bot_message_v17_0](img/scan_result_policy_example_bot_message_artifacts_v17_0.png)
Edited by Lee Tickett