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
1
Merge Requests
1
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
nexedi
gitlab-ce
Commits
5a9df82f
Commit
5a9df82f
authored
Aug 26, 2020
by
Mike Lewis
Committed by
Marcia Ramos
Aug 26, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix underscores vs hyphens content in Doc Style Guide
parent
93796580
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
5 additions
and
5 deletions
+5
-5
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+5
-5
No files found.
doc/development/documentation/styleguide.md
View file @
5a9df82f
...
...
@@ -189,10 +189,10 @@ The table below shows what kind of documentation goes where.
Do not use another file name and
**do not**
create
`README.md`
files.
1.
**Do not**
use special characters and spaces, or capital letters in file names,
directory names, branch names, and anything that generates a path.
1.
When creating
a new document
and it has more than one word in its name,
make sure to use underscores instead of spaces or dashes (
`-`
)
. For example,
a proper naming would be
`import_projects_from_github.md`
. The same rule
applies to imag
es.
1.
When creating
or renaming a file or directory
and it has more than one word in its name,
use underscores (
`_`
) instead of spaces or dashes
. For example,
proper naming would be
`import_project/import_from_github.md`
. This applies to
image files as well as Markdown fil
es.
1.
For image files, do not exceed 100KB.
1.
Do not upload video files to the product repositories.
[
Link or embed videos
](
#videos
)
instead.
...
...
@@ -214,7 +214,7 @@ The table below shows what kind of documentation goes where.
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.
`doc/topics/topic
_name/subtopic_
name/index.md`
when subtopics become necessary.
General user- and admin- related documentation, should be placed accordingly.
1.
The directories
`/workflow/`
,
`/university/`
, and
`/articles/`
have
been
**deprecated**
and the majority their docs have been moved to their correct location
...
...
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