diff options
| author | Marcia Ramos <virtua.creative@gmail.com> | 2017-12-21 14:42:05 +0000 |
|---|---|---|
| committer | Marcia Ramos <virtua.creative@gmail.com> | 2017-12-21 14:42:05 +0000 |
| commit | 889c7081f1c8bea2cd2cf7d50854babd7df92f72 (patch) | |
| tree | c53231b082e44678dfec5ad07155ecbb065a72ab | |
| parent | 899e9ec498c3e9c29802823c55503c46fe49396d (diff) | |
| parent | 007e51f12814ac836b47e649ca78f9b5b53e3dc7 (diff) | |
| download | gitlab-ce-889c7081f1c8bea2cd2cf7d50854babd7df92f72.tar.gz | |
Merge branch 'organise-by-subject' into 'master'
organise content by subject
See merge request gitlab-org/gitlab-ce!16080
| -rw-r--r-- | doc/development/doc_styleguide.md | 4 |
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 | |