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
42622c11
Commit
42622c11
authored
Apr 23, 2021
by
Suzanne Selhorn
Committed by
Susan Tacker
Apr 23, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Updated style for nav items
parent
515f6181
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
6 deletions
+15
-6
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+15
-6
No files found.
doc/development/documentation/styleguide/index.md
View file @
42622c11
...
...
@@ -1112,13 +1112,9 @@ document to ensure it links to the most recent version of the file.
When documenting navigation through the user interface:
-
Use the exact wording 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:
`From your project, go to **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:
`From your group, go to **Settings > CI/CD** and expand **General pipelines**`
.
-
Use bold text for navigation items.
###
Navigational element
s
###
What to call the menu
s
Use these terms when referring to the main GitLab user interface
elements:
...
...
@@ -1130,6 +1126,19 @@ elements:
-
**Right sidebar**
: This is the navigation sidebar on the right of the user
interface, specific to the open issue, merge request, or epic.
### How to document the left sidebar
To be consistent, use this format when you refer to the left sidebar.
-
Go to your project and select
**Settings > CI/CD**
.
-
Go to your group and select
**Settings > CI/CD**
.
-
Go to the Admin Area (
**{admin}**
) and select
**Overview > Projects**
.
For expandable menus, use this format:
1.
Go to your group and select
**Settings > CI/CD**
.
1.
Expand
**General pipelines**
.
## Images
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