summaryrefslogtreecommitdiff
path: root/doc/development/writing_documentation.md
diff options
context:
space:
mode:
authorPhil Hughes <me@iamphill.com>2018-02-19 15:54:01 +0000
committerPhil Hughes <me@iamphill.com>2018-02-19 15:54:01 +0000
commit0f5b56f96151b47957e7c497d44f983a23863086 (patch)
tree4db39f420153447ef7a2554d6fc406ce09aedb17 /doc/development/writing_documentation.md
parent704ec01955e98c9098e5e57c2d0cb0c2493af5ad (diff)
parentfb2a76ac484f5bba305abdf7b54a18ee8133f63f (diff)
downloadgitlab-ce-ph-dispatcher-cleanup.tar.gz
Merge branch 'master' into ph-dispatcher-cleanupph-dispatcher-cleanup
Diffstat (limited to 'doc/development/writing_documentation.md')
-rw-r--r--doc/development/writing_documentation.md31
1 files changed, 19 insertions, 12 deletions
diff --git a/doc/development/writing_documentation.md b/doc/development/writing_documentation.md
index 2a1d744668b..ceb0cdbb742 100644
--- a/doc/development/writing_documentation.md
+++ b/doc/development/writing_documentation.md
@@ -254,18 +254,25 @@ through the process of how to use it systematically.
#### Special format
-Every **Technical Article** contains, in the very beginning, a blockquote with the following information:
-
-- 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
-> **[Article Type](../../development/writing_documentation.html#types-of-technical-articles):** tutorial ||
-> **Level:** intermediary ||
-> **Author:** [Name Surname](https://gitlab.com/username) ||
-> **Publication date:** AAAA-MM-DD
+Every **Technical Article** contains a frontmatter at the beginning of the doc
+with the following information:
+
+- **Type of article** (user guide, admin guide, tech overview, tutorial)
+- **Knowledge level** expected from the reader to be able to follow through (beginner, intermediate, advanced)
+- **Author's name** and **GitLab.com handle**
+- **Publication date**
+
+For example:
+
+
+```yaml
+---
+author: John Doe
+author_gitlab: johnDoe
+level: beginner
+article_type: user guide
+date: 2017-02-01
+---
```
#### Technical Articles - Writing Method