summaryrefslogtreecommitdiff
path: root/doc/development/ux_guide/surfaces.md
diff options
context:
space:
mode:
authorawhildy <allison@gitlab.com>2016-10-21 14:25:09 -0700
committerawhildy <allison@gitlab.com>2016-11-10 14:09:35 -0800
commit11510bf729e04ea6f4a713820582b490266505d2 (patch)
tree6a822073373f36673ce6b390744ba143915daa90 /doc/development/ux_guide/surfaces.md
parenta3fd8521fb036b1f7153cad58234e8cb08246278 (diff)
downloadgitlab-ce-ux-guide-restructure.tar.gz
[ci skip] Establish basic structure for ux_guide README.mdux-guide-restructure
Block out pages needed for ux_guide Add resources stub to ux_guide home Fill out principles and basics Add TOC to basics Move all of UI guide to new UX guide structure Add first level structure on ux-guide pages Add more details to buttons Add button images. Update link on development Renamed surfaces to templates. Add tooltip details Update typography and icons on Basics page Add images for color. First draft of voice and tone Delete findings page Refine pages. Fill out Surfaces pages Clean up layout on basics, surfaces, features. Add anchorlinks and counts to components Fill out components page Add item title and system info block Fill out Features page Switch tooltip placement image
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