diff options
author | Marcia Ramos <marcia@gitlab.com> | 2019-06-26 17:07:01 +0300 |
---|---|---|
committer | Mike Lewis <mlewis@gitlab.com> | 2019-06-26 17:07:01 +0300 |
commit | a62d93f9091d0d7c7fa64eaf5161b5c6b1f77514 (patch) | |
tree | 7025dd894941160e651e789fe1022d4b8cd77349 | |
parent | 78c3e2d3d49b83a82a0a47ac10cf810e94333c1f (diff) |
Docs: require release version in image filenames
-rw-r--r-- | doc/development/documentation/styleguide.md | 21 |
1 files changed, 15 insertions, 6 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 23d52a33881..ff6dc16d1a0 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -409,11 +409,20 @@ To indicate the steps of navigation through the UI: ## Images - Place images in a separate directory named `img/` in the same directory where - the `.md` document that you're working on is located. Always prepend their - names with the name of the document that they will be included in. For - example, if there is a document called `twitter.md`, then a valid image name - could be `twitter_login_screen.png`. -- Images should have a specific, non-generic name that will differentiate and describe them properly. + the `.md` document that you're working on is located. +- Images should have a specific, non-generic name that will + differentiate and describe them properly. +- Always add to the end of the file name the GitLab release version + number corresponding to the release milestone the image was added to, + or corresponding to the release the screenshot was taken from, using the + format `image_name_vX_Y.png`. + ([Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/61027) in GitLab 12.1.) +- For example, for a screenshot taken from the pipelines page of + GitLab 11.1, a valid name is `pipelines_v11_1.png`. If you're + adding an illustration that does not include parts of the UI, + add the release number corresponding to the release the image + was added to. Example, for an MR added to 11.1's milestone, + a valid name for an illustration is `devops_diagram_v11_1.png`. - Keep all file names in lower case. - Consider using PNG images instead of JPEG. - Compress all images with <https://tinypng.com/> or similar tool. @@ -426,7 +435,7 @@ To indicate the steps of navigation through the UI: Inside the document: - The Markdown way of using an image inside a document is: - `![Proper description what the image is about](img/document_image_title.png)` + `![Proper description what the image is about](img/document_image_title_vX_Y.png)` - Always use a proper description for what the image is about. That way, when a browser fails to show the image, this text will be used as an alternative description. |