summaryrefslogtreecommitdiff
path: root/doc/development/ux_guide/surfaces.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/development/ux_guide/surfaces.md')
-rw-r--r--doc/development/ux_guide/surfaces.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/development/ux_guide/surfaces.md b/doc/development/ux_guide/surfaces.md
new file mode 100644
index 00000000000..d9e48a66185
--- /dev/null
+++ b/doc/development/ux_guide/surfaces.md
@@ -0,0 +1,53 @@
+# Surfaces
+
+## Contents
+* [Header](#header)
+* [Global menu](#global-menu)
+* [Side pane](#side-pane)
+* [Content area](#content-area)
+
+---
+
+![Surfaces UX](img/surfaces-ux.png)
+
+## Global menu
+
+This menu is to navigate to pages that contain content global to GitLab.
+
+---
+
+<br>
+
+## Header
+
+The header contains 3 main elements: Project switching and searching, user account avatar and settings, and a contextual menu that changes based on the current page.
+
+![Surfaces Header](img/surfaces-header.png)
+
+---
+
+<br>
+
+## Side pane
+
+The side pane holds supporting information and meta data for the information in the content area.
+
+---
+
+<br>
+
+## Content area
+
+The main content of the page. The content area can include other surfaces.
+
+### Item title bar
+
+The item title bar contains the top level information to identify the item, such as the name, id and status.
+
+![Item title](img/surfaces-contentitemtitle.png)
+
+### Item system information
+
+The system information block contains relevant system controlled information.
+
+![Item system information](img/surfaces-systeminformationblock.png) \ No newline at end of file