summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJob van der Voort <jobvandervoort@gmail.com>2017-12-21 13:31:41 +0000
committerJob van der Voort <jobvandervoort@gmail.com>2017-12-21 13:31:41 +0000
commit007e51f12814ac836b47e649ca78f9b5b53e3dc7 (patch)
treeaa5024b6c1aef16866efb494b6b5dfe5a04a36f8
parent3ee5fd156e3465a1e1c04b2b321c62b577496ee8 (diff)
downloadgitlab-ce-007e51f12814ac836b47e649ca78f9b5b53e3dc7.tar.gz
organise content by subjectorganise-by-subject
-rw-r--r--doc/development/doc_styleguide.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md
index db13e0e6249..9cb1f708a6a 100644
--- a/doc/development/doc_styleguide.md
+++ b/doc/development/doc_styleguide.md
@@ -18,6 +18,10 @@ like `docs.gitlab.com/user/project/merge_requests.html`. With this pattern,
you can immediately tell that you are navigating a user related documentation
and is about the project and its merge requests.
+Do not create summaries of similar types of content (e.g. an index of all articles, videos, etc.),
+rather organise content by its subject (e.g. everything related to CI goes together)
+and cross-link between any related content.
+
The table below shows what kind of documentation goes where.
| Directory | What belongs here |