summaryrefslogtreecommitdiff
path: root/doc/development/ux_guide/basics.md
blob: 62ac56a6bce9120f29e38acac4c10773637207ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# Basics

## Contents
* [Responsive](#responsive)
* [Typography](#typography)
* [Icons](#icons)
* [Color](#color)
* [Motion](#motion)
* [Voice and tone](#voice-and-tone)

---

## Responsive
GitLab is a responsive experience that works well across all screen sizes, from mobile devices to large monitors. In order to provide a great user experience, the core functionality (browsing files, creating issues, writing comments, etc.) must be available at all resolutions. However, due to size limitations, some secondary functionality may be hidden on smaller screens. Please keep this functionality limited to rare actions that aren't expected to be needed on small devices.

---

## Typography
### Primary typeface
GitLab's main typeface used throughout the UI is **Source Sans Pro**. We support both the bold and regular weight.

![Source Sans Pro sample](img/sourcesanspro-sample.png)


### Monospace typeface
This is the typeface used for code blocks. GitLab uses the OS default font.
- **Menlo** (Mac)
- **Consolas** (Windows)
- **Liberation Mono** (Linux)

![Monospace font sample](img/monospacefont-sample.png)

---

## Icons
GitLab uses Font Awesome icons throughout our interface.

![Trash icon](img/icon-trash.png)
The trash icon is used for destructive actions that deletes information.

![Edit icon](img/icon-edit.png)
The pencil icon is used for editing content such as comments.

![Notification icon](img/icon-notification.png)
The bell icon is for notifications, such as Todos.

![Subscribe icon](img/icon-subscribe.png)
The eye icon is for subscribing to updates. For example, you can subscribe to a label and get updated on issues with that label.

![RSS icon](img/icon-rss.png)
The standard RSS icon is used for linking to RSS/atom feeds.

![Close icon](img/icon-close.png)
An 'x' is used for closing UI elements such as dropdowns.

![Add icon](img/icon-add.png)
A plus is used when creating new objects, such as issues, projects, etc.

> TODO: update this section, add more general guidance to icon usage and personality, etc.

---

## Color

![Blue](img/color-blue.png)
Blue is used to highlight primary active elements (such as current tab), as well as other organization and managing commands.

![Green](img/color-green.png)
Green is for actions that create new objects.

![Orange](img/color-orange.png)
Orange is used for warnings

![Red](img/color-red.png)
Red is reserved for delete and other destructive commands

![Grey](img/color-grey.png)
Grey, and white (depending on context) is used for netral, secondary elements

> TODO: Establish a perspective for color in terms of our personality and rationalize with Marketing usage.

---

## Motion

Motion is a tool to help convey important relationships, changes or transitions between elements. It should be used sparingly and intentionally, highlighting the right elements at the right moment.

> TODO: Determine a more concrete perspective on motion, create consistent easing/timing curves to follow.

---

## Voice and tone

The copy for GitLab is clear and direct. We strike a clear balance between professional and friendly. We can empathesize with users (such as celebrating completing all Todos), and remain respectful of the importance of the work. We are that trusted, friendly coworker that is helpful and understanding.