Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Open sidebar
nexedi
gitlab-ce
Commits
5a9df82f
Commit
5a9df82f
authored
4 years ago
by
Mike Lewis
Committed by
Marcia Ramos
4 years ago
Browse files
Options
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.
...
@@ -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.
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,
1.
**Do not**
use special characters and spaces, or capital letters in file names,
directory names, branch names, and anything that generates a path.
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,
1.
When creating
or renaming a file or directory
and it has more than one word in its name,
make sure to
use underscores instead of spaces or dashes
(
`-`
)
. For example,
use underscores
(
`_`
)
instead of spaces or dashes. For example,
a
proper naming would be
`import_project
s
_from_github.md`
. Th
e same rule
proper naming would be
`import_project
/import
_from_github.md`
. Th
is applies to
applies to imag
es.
image files as well as Markdown fil
es.
1.
For image files, do not exceed 100KB.
1.
For image files, do not exceed 100KB.
1.
Do not upload video files to the product repositories.
1.
Do not upload video files to the product repositories.
[
Link or embed videos
](
#videos
)
instead.
[
Link or embed videos
](
#videos
)
instead.
...
@@ -214,7 +214,7 @@ The table below shows what kind of documentation goes where.
...
@@ -214,7 +214,7 @@ The table below shows what kind of documentation goes where.
the
**Visibility and Access Controls**
category should have a document
the
**Visibility and Access Controls**
category should have a document
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.
General user- and admin- related documentation, should be placed accordingly.
General user- and admin- related documentation, should be placed accordingly.
1.
The directories
`/workflow/`
,
`/university/`
, and
`/articles/`
have
1.
The directories
`/workflow/`
,
`/university/`
, and
`/articles/`
have
been
**deprecated**
and the majority their docs have been moved to their correct location
been
**deprecated**
and the majority their docs have been moved to their correct location
...
...
This diff is collapsed.
Click to expand it.
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