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
88d66248
Commit
88d66248
authored
Sep 10, 2019
by
Mike Lewis
Committed by
Evan Read
Sep 10, 2019
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Edits to Lists section of Documentation Style Guide
parent
200fd742
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
24 additions
and
17 deletions
+24
-17
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+24
-17
No files found.
doc/development/documentation/styleguide.md
View file @
88d66248
...
...
@@ -262,7 +262,7 @@ table_display_block: true
## Punctuation
Check the general punctuation rules for the GitLab documentation on the table below.
Check specific punctuation rules for [list
items](#list-item
s) below.
Check specific punctuation rules for [list
s](#list
s) below.
| Rule | Example |
| ---- | ------- |
...
...
@@ -274,37 +274,44 @@ Check specific punctuation rules for [list items](#list-items) below.
| Always add a space before and after dashes when using it in a sentence (for replacing a comma, for example). | _You should try this - or not._ |
| Always use lowercase after a colon. | _Related Issues: a way to create a relationship between issues._ |
## List
item
s
## Lists
- Always start list items with a capital letter, unless they are parameters or commands
that are in backticks, or similar.
- Always leave a blank line before and after a list.
- Begin a line with spaces (not tabs) to denote a [nested subitem](#nesting-inside-a-list-item).
- Only use ordered lists when their items describe a sequence of steps to follow:
Do:
### Ordered vs. unordered lists
These are the steps to do something:
Only use ordered lists when their items describe a sequence of steps to follow.
1. First, do step 1
1. Then, do step 2
1. Finally, do step 3
Do:
```
md
These are the steps to do something:
1.
First, do the first step.
1.
Then, do the next step.
1.
Finally, do the last step.
```
Don't:
Don't:
This is a list of different features:
```
md
This is a list of available features:
1. Feature 1
1. Feature 2
1. Feature 3
1.
Feature 1
1.
Feature 2
1.
Feature 3
```
**Markup:**
### Markup
- Use dashes (`-`) for unordered lists instead of asterisks (`*`).
- Prefix `1.` to e
ach
item in an ordered list.
- Prefix `1.` to e
very
item in an ordered list.
When rendered, the list items will appear with sequential numbering automatically.
**Punctuation:**
### Punctuation
- Do not add commas (`,`) or semicolons (`;`) to the end of list items.
- Only add periods to the end of a list item if the item consists of a complete sentence.
...
...
@@ -343,7 +350,7 @@ Do:
- Let's say this is also a complete sentence.
- Not a complete sentence.
Don't (
third item should have a `.` to match the first and second item
s):
Don't (
vary use of periods; majority rule
s):
- Let's say this is a complete sentence.
- Let's say this is also a complete sentence.
...
...
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