To speed up the work and have a result in #2904243: Implement the Out of the Box designs as a theme for demo_umami as soon as possible (and because of missing things in core, see eg. #2875935: Add Components Module to Drupal Core) we decided to abandon the style guide and work on implementing the theme.
Problem/Motivation
As part of creating a new theme we want to create a living style guide for maintaining the design components.
Proposed resolution
Use similar approach to what Styleguide module takes to render theme items on a page. The approach taken for this theme could be more simple since the components don't have to be pluggable, but could be just hard coded into one controller. This should be included in a separated module which is included in the installation profile. Current decision is to create the Living Styleguide as kss-node implementation.
Styleguide proposed structure
Guidelines
- Umami brand
- Design Principles
- Accessibility
General styles
- Typography
- Headings
- Text
- Links
- Colors
- Lines and backgrounds
Components
- Article (Full, Teaser, Highlighted Top, Highlighted Small)
- Banner (Left, Right)
- Form
- Button
- Checkbox
- Radio
- Input
- Label
- Select
- Text area
- Search box
- Search result
- Content list (1col, 2col, 3col, 4 col, list)
- Collection list
- Magazine promo
- Messages
- Navigation
- Breadcrumbs
- Main menu
- More link
- Tabs
- Recipie (Full, Teaser, Highlighted Top, Highlighted Bottom, Highlighted Small)
- Page
Regions
- Top
- Header
- Footer
- Bottom
Layouts
- 2 columns
- 1 column
Remaining tasks
- Create the styleguide with styles to be applied to the theme. Work currently done on Github: https://github.com/lauriii/umami See below the "How to contribute?" section
- Accessibility review
User interface changes
-
How to contribute?
- Most communication happens on Slack in the #out-of-the-box channel. It worth to join.
- There is a Google Drive folder with shared files (documents, assets etc.)
- Designs are attached to the summary of #2900720: Designs for the Out of the Box experience intiative and are also available in InVision.
- A styleguide pdf was created based on the designs which contains all the info needed to implement the design as an html / css styleguide. The latest version is attached to this issue in #16
- The tasks of creating the living styleguide elements based on the items in this issue summary were defined as issues on GitHub. (It needs to be considered that there are issues which depend on other issues so there is some kind of an implementation order.)
- Code contributions should be created as Pull Requests on GitHub.
Comment | File | Size | Author |
---|---|---|---|
#27 | Design Styleguide v2.pdf | 6.22 MB | kjay |
#16 | Design Styleguide v1.pdf | 6.02 MB | ckrina |
#15 | Design Styleguide v0.png | 553.97 KB | markconroy |
#9 | umami-components.png | 537.43 KB | ckrina |
#6 | 05-magazine.png | 440.15 KB | ckrina |
Comments
Comment #2
kostask CreditAttribution: kostask at Point Blank commentedCreated the umami_styleguide module based on the styleguide module at the Frontend United Athens sprint.
Comment #3
kostask CreditAttribution: kostask at Point Blank commentedComment #4
cilefen CreditAttribution: cilefen commentedComment #5
ckrinaI'll work on an index for the Styleguide. Here is a first proposal to be discussed:
Guidelines
General styles
Components
Regions
Layouts
Comment #6
ckrinaI've just updated a bit the previous proposed index, and I attach the wireframes with the components I've found. I'll be more than happy if anyone can review and make changes there.
Also, @kjay @lauriii I have a dilemma in the magazine section: the contents listed there are articles?
Comment #7
martin107 CreditAttribution: martin107 as a volunteer commentedWhile reading the issue over I found I want to embed the images into the issue summary.
Comment #8
martin107 CreditAttribution: martin107 as a volunteer commentedOh that is too much
moving the images to this comment
POST EDIT
That is still too much ...ckrina has solved the issue see below
so I am going the delete the images here.
ckrina++
Comment #9
ckrinaAfter yesterday's Out of the box meeting with @kjay and @markconroy we reviewed and updated the components list.
Some decisions taken is to keep the Magazine as a page content type for now, showing WYSIWYG capabilities. But we agreed that in the future it would have much sense to have a content type by itself.
I attach the components found in the wireframes and update the summary with the styleguide structure proposed.
Also @martin107 thank you for inserting the images! I've prepared a version with the components marked on the wireframes that maybe works better than each the previous separated images in a d.org issue :)
Comment #10
ckrinaCorrected the proposed components.
Comment #12
andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech for Limerick City & County Council commentedTagging. I'll be back for another look later.
Comment #13
webchickOver at #2900720-26: Designs for the Out of the Box experience intiative, we decided to move accessibility review to this issue vs. the design issue.
Comment #14
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commented@andrewmacpherson and @webchick,
While we are working out something more formal for the styleguide, I have set up a temporary site for testing here: http://umami-styleguide.mark.ie/
I'll be adding each element first on the parent page (the page you land on), then creating each component that we have registered in the issue summary (at http://umami-styleguide.mark.ie/components/*), then creating sample pages with each of those components (at http://umami-styleguide.mark.ie/pages.*).
Comment #15
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedAdding design styleguide, v0.
Comment #16
ckrinaAdding Design styleguide v1
Comment #17
ckrinaComment #18
ckrinaComment #19
ckrinaComment #20
thamasComment #21
thamasComment #22
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedI have created issues for each of the items in the issue summary here: https://github.com/lauriii/umami/issues
Comment #23
thamasComment #24
thamasComment #25
thamasComment #26
ckrinaAs @thamas updated on the issue, to speed up the work and have a result in #2904243: Implement the Out of the Box designs as a theme for demo_umami as soon as possible we decided to abandon the style guide and work on implementing the theme
Comment #27
kjay CreditAttribution: kjay commentedDesign styleguide PDF v2
Comment #28
andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech for Limerick City & County Council commentedJust noticed this has been postponed. Fair enough.
Over at #2900720-24: Designs for the Out of the Box experience intiative webchick and I agreed that accessibility sign-off would be move to this styleguide issue. Since this one is now postponed, I'll treat #2904243: Implement the Out of the Box designs as a theme for demo_umami as the main target for accessibility review.
Leaving the "needs accesibility review" issue on this issue, for whenever we come back to it.
Comment #29
andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech for Limerick City & County Council commentedMuch more a11y work has been done in the theme code itself, in the lauriii/Umami github repo.
Removing the needs a11y review tag. If we come back to a living styleguide, we'll review it again.
Comment #30
markconroy CreditAttribution: markconroy as a volunteer and at Annertech commentedClosing this issue. The work is being done in other issues.