Update alt text for images
❗ COMMUNITY CONTRIBUTORS, PLEASE ONLY PICK UP 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:
- Familiarize yourself with style guidance for writing alt text.
- Open this spreadsheet.
- 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 ONE doc file. Many people want to contribute, so we'd like everyone to have an opportunity.
- 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.
- Combine related changes into the same merge request. If one file has several images with alt-text to update, make all the changes in the same merge request. Do not create multiple small merge requests for the same file.
- In the merge request description, include this text:
Related to: https://gitlab.com/gitlab-org/gitlab/-/issues/479161 - Add the MR to the spreadsheet.
- After your merge request is created, look for a message from @gitlab-bot . This message has instructions for what to do when you’re ready for review.
Thank you in advance for your contribution!
Alt text examples
Examples of helpful alt text:

Examples of alt text that can be improved:

Edited by Marcel Amirault