root
/
gitlab-ce
mirror of https://gitlab.com/free-releases/gitlab-ce.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

add link to "writing docs" , fix typo

This commit is contained in:
Marcia Ramos 2017-03-28 23:35:03 -03:00
parent dd4893513f
commit df9fb04f87
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/development/doc_styleguide.md
View File

@ -3,6 +3,8 @@
This styleguide recommends best practices to improve documentation and to keep This styleguide recommends best practices to improve documentation and to keep
it organized and easy to find. it organized and easy to find.
See also [writing documentation](writing_documentation.md).
## Location and naming of documents ## Location and naming of documents
>**Note:** >**Note:**
@ -59,7 +61,7 @@ The table below shows what kind of documentation goes where.
located at `doc/user/admin_area/settings/visibility_and_access_controls.md`. located at `doc/user/admin_area/settings/visibility_and_access_controls.md`.
1. The `doc/topics/` directory holds topic-related technical content. Create 1. The `doc/topics/` directory holds topic-related technical content. Create
`doc/topics/topic-name/subtopic-name/index.md` when subtopics become necessary. `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 Note that `topics` holds the index page per topic, and technical articles. General
user- and admin- related documentation, should be placed accordingly. user- and admin- related documentation, should be placed accordingly.
--- ---