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/writing_documentation.md | |
parent | aec53bab05afd0a20b15bd9311643f8bf5efd140 (diff) | |
download | gitlab-ce-9e8ed540b75d24484f19f36cf6e95a199135b935.tar.gz |
Complement tech articles guidelines
Diffstat (limited to 'doc/development/writing_documentation.md')
-rw-r--r-- | doc/development/writing_documentation.md | 6 |
1 files changed, 4 insertions, 2 deletions
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 |