summaryrefslogtreecommitdiff
path: root/doc/development/doc_styleguide.md
diff options
context:
space:
mode:
authorFilipa Lacerda <filipa@gitlab.com>2017-12-22 06:47:54 +0000
committerFilipa Lacerda <filipa@gitlab.com>2017-12-22 06:47:54 +0000
commit4423b299b73e2b96b980b848fab5cf374361572b (patch)
tree8f2c7b12b3c267efda53918f67210225fac017ff /doc/development/doc_styleguide.md
parent0b5947849a32991904f8cbc5e4612d2438b97e0b (diff)
parent36f4710301926bb853b35d9b14a60e03b42def34 (diff)
downloadgitlab-ce-4423b299b73e2b96b980b848fab5cf374361572b.tar.gz
Merge branch 'master' into 22643-manual-job-page
* master: (68 commits) Last push event widget width for fixed layout Added 'admin' persona Docs: move article Artifactory + GL to subject-related folder Mention GitLab Pages when changing username Consolidate the docs when changing a repo path Add docs for automatic redirects when renaming namespaces move "Transfer an existing project into a group" to project docs Do not show Vue pagination if only one page Resolve "Decouple multi-file editor from file list" Update Ruby version to 2.3.6 Skip projects filter on merge requests search Fall back to the `MergeRequestWidgetEntity` LDAP extern_uids are not normalized when updated via API organise content by subject Restore missing language code in datetime_utility.js Add support for defining explicit dependencies to QA factories Document mounting volumes with Docker-in-Docker add missing word to pawel-reduce_cardinality_of_prometheus_metrics.yml Use seconds where possible, and convert to milliseconds for Influxdb consumption update dispatcher to allow for dynamic imports until webpack plugin is updated ...
Diffstat (limited to 'doc/development/doc_styleguide.md')
-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 |