diff options
| author | Marcia Ramos <virtua.creative@gmail.com> | 2018-06-20 09:48:34 +0000 |
|---|---|---|
| committer | Marcia Ramos <virtua.creative@gmail.com> | 2018-06-20 09:48:34 +0000 |
| commit | 25f90286f219f74ccb7a117ea760d036a7dadd1f (patch) | |
| tree | 4c0a07ccbbeec1c6a88c2d75490ed5a434c509cd | |
| parent | ed2fde007132533008b669be764cbc231a456a44 (diff) | |
| download | gitlab-ce-25f90286f219f74ccb7a117ea760d036a7dadd1f.tar.gz | |
Update styleguide.md with rules for navigation items
| -rw-r--r-- | doc/development/documentation/styleguide.md | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index e7ffba635c9..a0348120089 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -26,7 +26,10 @@ Check the GitLab handbook for the [writing styles guidelines](https://about.gitl - Jump a line between different markups (e.g., after every paragraph, header, list, etc) - Capitalize "G" and "L" in GitLab - Use sentence case for titles, headings, labels, menu items, and buttons. -- Use title case when referring to [features](https://about.gitlab.com/features/) or [products](https://about.gitlab.com/pricing/), and methods. Note that some features are also objects (e.g. "Merge Requests" and "merge requests"). E.g.: GitLab Runner, Geo, Issue Boards, Git, Prometheus, Continuous Integration. +- Use title case when referring to [features](https://about.gitlab.com/features/) or +[products](https://about.gitlab.com/pricing/), and methods. Note that some +features are also objects (e.g. "Merge Requests" and "merge requests"). +E.g.: GitLab Runner, Geo, Issue Boards, Git, Prometheus, Continuous Integration. ## Formatting @@ -72,7 +75,7 @@ For punctuation rules, please refer to the [GitLab UX guide](https://design.gitl This is to ensure that no document with wrong heading is going live without an audit, thus preventing dead links and redirection issues when corrected -- Leave exactly one newline after a heading +- Leave exactly one new line after a heading ## Links @@ -95,6 +98,16 @@ For punctuation rules, please refer to the [GitLab UX guide](https://design.gitl E.g., instead of writing something like `Read more about GitLab Issue Boards [here](LINK)`, write `Read more about [GitLab Issue Boards](LINK)`. +## Navigation + +To indicate the steps of navigation through the UI: + +- Use the exact word as shown in the UI, including any capital letters as-is +- Use bold text for navigation items and the char `>` as separator +(e.g., `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 + ## Images - Place images in a separate directory named `img/` in the same directory where |