Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcia Ramos <virtua.creative@gmail.com>2017-03-23 02:42:54 +0300
committerMarcia Ramos <virtua.creative@gmail.com>2017-03-23 02:42:54 +0300
commitbbd5493428efcce72388f08b7feda722aa5e1b2c (patch)
tree5a8f69e979def13adfe0251e28685cb537779f3f /doc/development/doc_styleguide.md
parentc7b4b150d5db73d453398f01754ea14aaa2254ff (diff)
add instructions on subtopics
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 1d4dfeea6b1..3c755c192fa 100644
--- a/doc/development/doc_styleguide.md
+++ b/doc/development/doc_styleguide.md
@@ -57,6 +57,10 @@ The table below shows what kind of documentation goes where.
own document located at `doc/user/admin_area/settings/`. For example,
the **Visibility and Access Controls** category should have a document
located at `doc/user/admin_area/settings/visibility_and_access_controls.md`.
+1. The `doc/topics/` directory holds topic-related technical content. Create
+ `doc/topics/topic-name/subtopic-name/index.md` when subtopics become necessary.
+ Note that `topics` holds the index page per topic, and techical articles. General
+ user- and admin- related documentation, should be placed accordingly.
---