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
4c3ac270
Commit
4c3ac270
authored
Jun 09, 2021
by
Suzanne Selhorn
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Updated nav guidance for 14.0 changes
Related to:
https://gitlab.com/gitlab-org/gitlab/-/issues/301143
parent
6dfed16d
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
19 additions
and
13 deletions
+19
-13
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+19
-13
No files found.
doc/development/documentation/styleguide/index.md
View file @
4c3ac270
...
@@ -1069,36 +1069,42 @@ document to ensure it links to the most recent version of the file.
...
@@ -1069,36 +1069,42 @@ document to ensure it links to the most recent version of the file.
## Navigation
## Navigation
When documenting navigation through the user interface:
When documenting navigation through the user interface, use these terms and styles.
-
Use the exact wording as shown in the UI, including any capital letters as-is.
-
Use bold text for navigation items.
### What to call the menus
### What to call the menus
Use these terms when referring to the main GitLab user interface
Use these terms when referring to the main GitLab user interface
elements:
elements:
-
**Top
menu**
: This is the top menu
that spans the width of the user interface.
-
**Top
bar**
: This is the top bar
that spans the width of the user interface.
It includes the GitLab logo, search field, counters, and the user's avatar.
It includes the
menu, the
GitLab logo, search field, counters, and the user's avatar.
-
**Left sidebar**
: This is the navigation sidebar on the left of the user
-
**Left sidebar**
: This is the navigation sidebar on the left of the user
interface, specific to the project or group.
interface, specific to the project or group.
-
**Right sidebar**
: This is the navigation sidebar on the right of the user
-
**Right sidebar**
: This is the navigation sidebar on the right of the user
interface, specific to the open issue, merge request, or epic.
interface, specific to the open issue, merge request, or epic.
### How to document the
left sidebar
### How to document the
menus
To be consistent, use this format when you
refer to the left sidebar
.
To be consistent, use this format when you
write about UI navigation
.
-
Go to your project and select
**Settings > CI/CD**
.
1.
On the top bar, select
**Menu > Project**
and find your project
.
-
Go to your group and
select
**Settings > CI/CD**
.
1.
On the left sidebar,
select
**Settings > CI/CD**
.
-
Go to the Admin Area (
**{admin}**
) and select
**Overview > Project
s**
.
1.
Expand
**General pipeline
s**
.
For expandable menus, use this format
:
Another example
:
1.
Go to your group and select
**Settings > CI/CD**
.
1.
On the top bar, select
**Menu > Group**
and find your group.
1.
On the left sidebar, select
**Settings > CI/CD**
.
1.
Expand
**General pipelines**
.
1.
Expand
**General pipelines**
.
An Admin Area example:
`1. On the top bar, select **Menu >** **{admin}** **Admin**.`
This text generates this HTML:
1.
On the top bar, select
**Menu >**
**{admin}**
**Admin**
.
## Images
## Images
Images, including screenshots, can help a reader better understand a concept.
Images, including screenshots, can help a reader better understand a concept.
...
...
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