Commit d6b93e31 authored by Craig Norris's avatar Craig Norris

Merge branch 'selhorn-nav-guidance-updates' into 'master'

Updated nav guidance for 14.0 changes

See merge request gitlab-org/gitlab!63688
parents 6261e620 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 > Projects**. 1. Expand **General pipelines**.
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.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment