diff options
| author | Marcia Ramos <virtua.creative@gmail.com> | 2017-03-22 20:42:54 -0300 |
|---|---|---|
| committer | Marcia Ramos <virtua.creative@gmail.com> | 2017-03-22 20:42:54 -0300 |
| commit | bbd5493428efcce72388f08b7feda722aa5e1b2c (patch) | |
| tree | 5a8f69e979def13adfe0251e28685cb537779f3f /doc | |
| parent | c7b4b150d5db73d453398f01754ea14aaa2254ff (diff) | |
| download | gitlab-ce-bbd5493428efcce72388f08b7feda722aa5e1b2c.tar.gz | |
add instructions on subtopics
Diffstat (limited to 'doc')
| -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 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. --- |