diff options
author | Marcia Ramos <virtua.creative@gmail.com> | 2017-05-11 10:51:39 +0000 |
---|---|---|
committer | Sean Packham (GitLab) <sean@seanpackham.com> | 2017-05-11 10:51:39 +0000 |
commit | 9e8ed540b75d24484f19f36cf6e95a199135b935 (patch) | |
tree | 8abb75014af83731b2682ed5e84a2a048c71629a /doc/development | |
parent | aec53bab05afd0a20b15bd9311643f8bf5efd140 (diff) | |
download | gitlab-ce-9e8ed540b75d24484f19f36cf6e95a199135b935.tar.gz |
Complement tech articles guidelines
Diffstat (limited to 'doc/development')
-rw-r--r-- | doc/development/doc_styleguide.md | 9 | ||||
-rw-r--r-- | doc/development/writing_documentation.md | 6 |
2 files changed, 12 insertions, 3 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: diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md index 2814c18e0b6..657a826d7ee 100644 --- a/doc/development/writing_documentation.md +++ b/doc/development/writing_documentation.md @@ -52,11 +52,13 @@ Every **Technical Article** contains, in the very beginning, a blockquote with t - A reference to the **type of article** (user guide, admin guide, tech overview, tutorial) - A reference to the **knowledge level** expected from the reader to be able to follow through (beginner, intermediate, advanced) - A reference to the **author's name** and **GitLab.com handle** +- A reference of the **publication date** ```md -> **Type:** tutorial || +> **Article [Type](../../development/writing_documentation.html#types-of-technical-articles):** tutorial || > **Level:** intermediary || -> **Author:** [Name Surname](https://gitlab.com/username) +> **Author:** [Name Surname](https://gitlab.com/username) || +> **Publication date:** AAAA/MM/DD ``` #### Technical Articles - Writing Method |