summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVictor Wu <wu.victor@gmail.com>2016-11-16 22:34:20 +0000
committerVictor Wu <wu.victor@gmail.com>2016-11-16 22:34:20 +0000
commit6c8adaff92dc496ea317747993d26396509438e4 (patch)
treed53a91df04c78670cfd1afc05d5e6a6182a64f3f
parent111c4e628e7cf1c70a15346523941e30e2541a72 (diff)
downloadgitlab-ce-6c8adaff92dc496ea317747993d26396509438e4.tar.gz
Update examples and labels to use sentence case.
-rw-r--r--doc/development/ux_guide/copy.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/development/ux_guide/copy.md b/doc/development/ux_guide/copy.md
index f96aaf74037..48010c6510c 100644
--- a/doc/development/ux_guide/copy.md
+++ b/doc/development/ux_guide/copy.md
@@ -22,7 +22,7 @@ The current navigation and composition of the elements on the screen should get
This means that, as a rule, copy should be very short. A long message or label is a red flag hinting at design that needs improvement.
>**Example:**
-Use `Add` instead of `Add Issue` as a button label.
+Use `Add` instead of `Add issue` as a button label.
Preferrably use context and placement of controls to make it obvious what clicking on them will do.
---
@@ -31,21 +31,21 @@ Preferrably use context and placement of controls to make it obvious what clicki
### Adding Items
-When viewing a list of issues, there is a button that is labeled `Add`. Given the context in the example, it is clearly referring to issues. If the context were not clear enough, the label could be `Add Issue`. Clicking the button will bring you to the `Add Issue` form. Other add flows should be similar.
+When viewing a list of issues, there is a button that is labeled `Add`. Given the context in the example, it is clearly referring to issues. If the context were not clear enough, the label could be `Add issue`. Clicking the button will bring you to the `Add issue` form. Other add flows should be similar.
![Add issue button](img/copy-form-addissuebutton.png)
-The form should be titled `Add Issue`. The submit button should be labeled `Submit`. Don't use `Add`, `Create`, `New`, or `Save Changes`. The cancel button should be labeled `Cancel`. Don't use `Back`.
+The form should be titled `Add issue`. The submit button should be labeled `Submit`. Don't use `Add`, `Create`, `New`, or `Save changes`. The cancel button should be labeled `Cancel`. Don't use `Back`.
![Add issue form](img/copy-form-addissueform.png)
-### Editing Items
+### Editing items
-When in context of an issue, the affordance to edit it is labeled `Edit`. If the context is not clear enough, `Edit Issue` could be considered. Other edit flows should be similar.
+When in context of an issue, the affordance to edit it is labeled `Edit`. If the context is not clear enough, `Edit issue` could be considered. Other edit flows should be similar.
![Edit issue button](img/copy-form-editissuebutton.png)
-The form should be titled `Edit Issue`. The submit button should be labeled `Save`. Don't use `Edit`, `Update`, `Submit`, or `Save Changes`. The cancel button should be labeled `Cancel`. Don't use `Back`.
+The form should be titled `Edit issue`. The submit button should be labeled `Save`. Don't use `Edit`, `Update`, `Submit`, or `Save changes`. The cancel button should be labeled `Cancel`. Don't use `Back`.
![Edit issue form](img/copy-form-editissueform.png)
@@ -56,7 +56,7 @@ Only use the terms in the tables below.
### Issues
-#### Adjectives (States)
+#### Adjectives (states)
| Term |
| ---- |
@@ -67,7 +67,7 @@ Only use the terms in the tables below.
>**Example:**
Use `5 open issues` and don't use `5 pending issues`.
-#### Verbs (Actions)
+#### Verbs (actions)
| Term | Use | Don't |
| ---- | --- | --- |
@@ -78,16 +78,16 @@ Use `5 open issues` and don't use `5 pending issues`.
| Re-open | Re-open a closed issue | There should never be a need to use `open` as a verb |
| Delete | Delete an open or closed issue ||
-### Merge Requests
+### Merge requests
-#### Adjectives (States)
+#### Adjectives (states)
| Term |
| ---- |
| Open |
| Merged |
-#### Verbs (Actions)
+#### Verbs (actions)
| Term | Use | Don't |
| ---- | --- | --- |