diff options
| author | Marcia Ramos <virtua.creative@gmail.com> | 2017-05-10 15:30:16 -0300 |
|---|---|---|
| committer | Marcia Ramos <virtua.creative@gmail.com> | 2017-05-10 15:30:16 -0300 |
| commit | 88f67aba4f455626c2faf5c6bd68db1a81754423 (patch) | |
| tree | 896db2e506584a131127af1f4a6afe6433c6e80d | |
| parent | ade8fa3d06aa989461a28ac394febddfea37e340 (diff) | |
| download | gitlab-ce-docs/complement-tech-articles.tar.gz | |
add exception (filename) for articles' imagesdocs/complement-tech-articles
| -rw-r--r-- | doc/development/doc_styleguide.md | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index 1e81905c081..5b09f79f143 100644 --- a/doc/development/doc_styleguide.md +++ b/doc/development/doc_styleguide.md @@ -198,10 +198,17 @@ You can combine one or more of the following: 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`. + could be `twitter_login_screen.png`. [**Exception**: images for + [articles](writing_documentation.md#technical-articles) should be + put in a directory called `img` underneath `/articles/article_title/img/`, therefore, + there's no need to prepend the document name to their filenames.] - Images should have a specific, non-generic name that will differentiate them. - Keep all file names in lower case. - Consider using PNG images instead of JPEG. +- Compress all images with <https://tinypng.com/> or similar tool. +- Compress gifs with <https://ezgif.com/optimize> or similar toll. +- Images should be used (only when necessary) to _illustrate_ the description +of a process, not to _replace_ it. Inside the document: |