UX guide restructure
The goal of this MR was to update the current UI guide to more of an UX guide (starting to detail when to use certain controls and patterns), and add structure to help organize the information. This initial version of the UX guide also lays down the groundwork for principles and personality. This guide is currently documenting the existing design, and will continue to be updated as the design evolves.
Some inspiration/references used:
Merge request reports
Activity
Added 2 commits:
Mentioned in issue #23736 (closed)
Added 1 commit:
- 6ed37c75 - Renamed surfaces to templates. Add tooltip details
Added 1 commit:
- 18c884bd - Add images for color. First draft of voice and tone
Added 2 commits:
Added 1 commit:
- 9175fb5d - Clean up layout on basics, surfaces, features. Add anchorlinks and counts to components
Added 2 commits:
Added 473 commits:
-
b929fb3e...a6b49757 - 472 commits from branch
master - 9c976753 - Establish basic structure for ux_guide README.md
-
b929fb3e...a6b49757 - 472 commits from branch
Added Ready for Merge label
Added 51 commits:
-
9c976753...c6d01098 - 50 commits from branch
master - 30c092c8 - Establish basic structure for ux_guide README.md
-
9c976753...c6d01098 - 50 commits from branch
Added 88 commits:
-
30c092c8...2976ad40 - 87 commits from branch
master - cd947170 - Establish basic structure for ux_guide README.md
-
30c092c8...2976ad40 - 87 commits from branch
Added 49 commits:
-
cd947170...a3fd8521 - 48 commits from branch
master - 11510bf7 - [ci skip] Establish basic structure for ux_guide README.md
-
cd947170...a3fd8521 - 48 commits from branch
-
@axil: Would you be able to review and merge this, or should I ask someone else? Thanks!
Reassigned to @axil
@awhildy yep, I'll take a look :)
-
Awesome! I pushed some things :)
- I renamed
README.mdtoindex.md(in order to render as/ux_guide/in the docs portal and not having to type the ugly `ux_guide/README.html) - The
are not really needed. Markdown adds its own padding :) - I replaced multi-blockquotes to single ones, as this is specific to GitLab and it won't render correctly in docs.gitlab.com
Edited by Achilleas Pipinellis - I renamed
-
Thanks @victorwu for the addition :) I'll merge now.
Mentioned in commit 8458f53c
@axil : If you renamed it index.md, then the file won't render in GitLab right? The convention is to use README.md as the intro page, and GitLab, GitHub, and most tools will render it?
So right now, it won't be rendered here: https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/development/ux_guide
-
@victorwu I totally see your point, but since we're moving forward to deprecating the
/helppage and focusing on https://docs.gitlab.com, having clean URLs instead ofREADME.htmlmakes much more sense. I'd expect people to navigate through the docs portal instead of the repository.Welcome to the ongoing discussion of having to maintain two sets of docs :) The one rendered under
/help(GitLab's built-in docs) and https://docs.gitlab.com. Read the following for some context:- Remove Help section from the Rails app
- Start using index.md instead of README.md in our docs
- [proposal] Make index.md render like README.md when it's present in a repository
- Help page related issues
If you have any thoughts on the matter please do share in the issues above :)
-
The docs are live at https://docs.gitlab.com/ce/development/ux_guide/ btw :)
Mentioned in merge request !7444 (merged)
Mentioned in commit 64802597
Sounds good @axil. It looks like this has been discussed and is the intentional structure. Great! Thanks for the background.
So for this page, will it be retired, is it already in the docs somewhere, or should there be a link it from one of the docs pages?
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/README.md
-
@victorwu no this is the project's page and is not rendered in the docs portal. Only what's inside
doc/is picked :) You can see what gets picked from our various products in https://gitlab.com/gitlab-com/gitlab-docs/blob/master/Rakefile. 
@awhildy awesome work, thanks!
