summaryrefslogtreecommitdiff
path: root/doc/development/ux_guide/README.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/README.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/README.md')
-rw-r--r--doc/development/ux_guide/README.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/doc/development/ux_guide/README.md b/doc/development/ux_guide/README.md
new file mode 100644
index 00000000000..e17a4559069
--- /dev/null
+++ b/doc/development/ux_guide/README.md
@@ -0,0 +1,59 @@
+# GitLab UX Guide
+
+The goal of this guide is to provide standards, principles and in-depth information to design beautiful and effective GitLab features. This will be a living document, and we welcome contributions, feedback and suggestions.
+
+## Design
+
+---
+
+### [Principles](principles.md)
+These guiding principles set a solid foundation for our design system, and should remain relatively stable over multiple releases. They should be referenced as new design patterns are created.
+
+---
+
+### [Basics](basics.md)
+The basic ingredients of our experience establish our personality and feel. This section includes details about typography, color, and motion.
+
+---
+
+### [Components](components.md)
+Components are the controls that make up the GitLab experience, including guidance around buttons, links, dropdowns, etc.
+
+---
+
+### [Surfaces](surfaces.md)
+The GitLab experience is broken apart into several surfaces. Each of these surfaces is designated for a specific scope or type of content. Examples include the header, global menu, side pane, etc.
+
+---
+
+### [Features](features.md)
+The previous building blocks are combined into complete features in the GitLab UX. Examples include our navigation, filters, search results, and empty states.
+
+---
+
+<br>
+
+## Research
+
+---
+
+### [Users](users.md)
+How we think about the variety of users of GitLab, from small to large teams, comparing opensource usage to enterprise, etc.
+
+---
+
+<br>
+
+## Other
+
+---
+
+### [Tips for designers](tips.md)
+Tips for exporting assets, and other guidance.
+
+---
+
+### [Resources](resources.md)
+Resources for GitLab UX
+
+---