Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
df9fb04f
Commit
df9fb04f
authored
Mar 28, 2017
by
Marcia Ramos
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
add link to "writing docs" , fix typo
parent
dd489351
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
3 additions
and
1 deletion
+3
-1
doc/development/doc_styleguide.md
doc/development/doc_styleguide.md
+3
-1
No files found.
doc/development/doc_styleguide.md
View file @
df9fb04f
...
@@ -3,6 +3,8 @@
...
@@ -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.
...
@@ -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 tech
n
ical articles. General
user- and admin- related documentation, should be placed accordingly.
user- and admin- related documentation, should be placed accordingly.
---
---
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment