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
Léo-Paul Géneau
gitlab-ce
Commits
40aba812
Commit
40aba812
authored
Oct 10, 2018
by
Evan Read
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add new styleguide sections for verbs
Also fixes spelling, and makes the Markdown style more consistent.
parent
b83be503
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
31 additions
and
3 deletions
+31
-3
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+31
-3
No files found.
doc/development/documentation/styleguide.md
View file @
40aba812
...
@@ -210,7 +210,7 @@ For other punctuation rules, please refer to the
...
@@ -210,7 +210,7 @@ For other punctuation rules, please refer to the
-
Use inline link markdown markup
`[Text](https://example.com)`
.
-
Use inline link markdown markup
`[Text](https://example.com)`
.
It's easier to read, review, and maintain.
**Do not**
use
`[Text][identifier]`
.
It's easier to read, review, and maintain.
**Do not**
use
`[Text][identifier]`
.
-
To link to internal documentation, use relative links, not full URLs. Use
`../`
to
-
To link to internal documentation, use relative links, not full URLs. Use
`../`
to
navigate t
p
high-level directories, and always add the file name
`file.md`
at the
navigate t
o
high-level directories, and always add the file name
`file.md`
at the
end of the link with the
`.md`
extension, not
`.html`
.
end of the link with the
`.md`
extension, not
`.html`
.
Example: instead of
`[text](../../merge_requests/)`
, use
Example: instead of
`[text](../../merge_requests/)`
, use
`[text](../../merge_requests/index.md)`
or,
`[text](../../ci/README.md)`
, or,
`[text](../../merge_requests/index.md)`
or,
`[text](../../ci/README.md)`
, or,
...
@@ -386,8 +386,32 @@ Which renders to:
...
@@ -386,8 +386,32 @@ Which renders to:
## Specific sections and terms
## Specific sections and terms
To mention and/or reference specific terms in GitLab, please follow the styles
To maintain consistency through GitLab documentation, the following guides documentation authors
below.
on agreed styles and usage of terms.
### Describing UI elements
The following are styles to follow when describing UI elements on a screen:
-
For elements with a visible label, use that label in bold with matching case. For example,
`the **Cancel** button`
.
-
For elements with a tooltip or hover label, use that label in bold with matching case. For example,
`the **Add status emoji** button`
.
### Verbs for UI elements
The following are verbs that should be used in preference to alternatives.
| Use | Used for | Do not use |
|:---------|:--------------------------------|:---------------------------|
| "click" | buttons, links, menu items | "hit", "press", "select" |
| "check" | checkboxes | "enable", "click", "press" |
| "select" | dropdowns | "pick" |
| "expand" | expandable sections | "open" |
### Other Verbs
| Use | Used for | Do not use |
|:---------|:--------------------------------|:---------------------------|
| "go" | making a browser go to location | "navigate", "open" |
### GitLab versions and tiers
### GitLab versions and tiers
...
@@ -460,6 +484,10 @@ the special markup `**[STARTER]**` will generate a `span` element to trigger the
...
@@ -460,6 +484,10 @@ the special markup `**[STARTER]**` will generate a `span` element to trigger the
badges and tooltips (
`<span class="badge-trigger starter">`
). When the keyword
badges and tooltips (
`<span class="badge-trigger starter">`
). When the keyword
"only" is added, the corresponding GitLab.com badge will not be displayed.
"only" is added, the corresponding GitLab.com badge will not be displayed.
## Specific sections
Certain styles should be applied to specific sections. Styles for specific sections are outlined below.
### GitLab Restart
### GitLab Restart
There are many cases that a restart/reconfigure of GitLab is required. To
There are many cases that a restart/reconfigure of GitLab is required. To
...
...
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