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
54211dd6
Commit
54211dd6
authored
Sep 21, 2020
by
Russell Dickenson
Committed by
Craig Norris
Sep 21, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added standard terms for UI navigation
parent
a51c9471
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
17 additions
and
5 deletions
+17
-5
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+17
-5
No files found.
doc/development/documentation/styleguide.md
View file @
54211dd6
...
...
@@ -1097,14 +1097,26 @@ document to ensure it links to the most recent version of the file.
## Navigation
To indicate the steps of
navigation through the user interface:
When documenting
navigation through the user interface:
-
Use the exact word as shown in the UI, including any capital letters as-is.
-
Use the exact word
ing
as shown in the UI, including any capital letters as-is.
-
Use bold text for navigation items and the char "greater than" (
`>`
) as a
separator
(for example,
`Navigate to your project's **Settings > CI/CD**`
)
.
separator
. For example:
`Navigate to your project's **Settings > CI/CD**`
.
-
If there are any expandable menus, make sure to mention that the user needs to
expand the tab to find the settings you're referring to (for example,
`Navigate to your project's **Settings > CI/CD** and expand **General pipelines**`
).
expand the tab to find the settings you're referring to. For example:
`Navigate to your project's **Settings > CI/CD** and expand **General pipelines**`
.
### Navigational elements
Use the following terms when referring to the main GitLab user interface
elements:
-
**Top menu**
: This is the top menu that spans the width of the user interface.
It includes the GitLab logo, search field, counters, and the user's avatar.
-
**Left sidebar**
: This is the navigation sidebar on the left of the user
interface, specific to the project or group.
-
**Right sidebar**
: This is the navigation sidebar on the right of the user
interface, specific to the open issue, merge request, or epic.
## Images
...
...
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