Docs: screenshots guidelines - add GL version to file name
Problem to solve
- Screenshots often get outdated.
- We don't have a way to identify what GitLab version that screenshot was taken from.
- We don't have a way to search for outdated screenshots. We eventually come across and fix them ad-hoc.
Proposal
Create a documentation guideline for screenshots:
Every screenshot, gif, video, or any illustration what exhibits the GitLab UI must include in its file name the GitLab version it was taken from.
By doing so, we not only can easily visually identify the corresponding GL version in images from the document they were linked from (like, ![Alt](img/filename_11_10.png)
), but also use RegEx to perform automated searches.
Further details
We can either:
-
A: Use the format
file_name_X_Y.png
, e.g.,pipelines_11_10.png
-
B: Use the format
file_name_vX_Y.png
, e.g.,pipelines_v11_10.png
Who can address the issue
-
@marcia to create the MR with the proposed change added to the style guide -
One of the @gl-docsteam members to announce in the company call
Other links/references
- Example: https://gitlab.com/gitlab-org/gitlab-ce/blob/65dacc2ccedfea05ddc3cee20d3942e908d70b3f/doc/ci/img/add_file_template_11_10.png
- Discussion on Slack with many insights from the docs team: https://gitlab.slack.com/archives/CCB575BGT/p1556126587067200
Edited by Marcia Ramos