Navigation Menu

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create a "CSS Style Guide" for core & plugin developers #7652

Open
tzi opened this issue Apr 9, 2015 · 8 comments
Open

Create a "CSS Style Guide" for core & plugin developers #7652

tzi opened this issue Apr 9, 2015 · 8 comments
Labels
c: Design / UI For issues that impact Matomo's user interface or the design overall. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself.
Milestone
Backlog (Help wan...

Comments

@tzi
Copy link
Member

tzi commented Apr 9, 2015

Hi piwik team!

As discussed in #7390, it could be urseful to have a CSS style guide for the developers.

The purpose of this minisite is to document our CSS code base, especially the reusable components:

  • It shows the "CSS API" usable by the developers
  • It shows the components that should be restyled in themes
  • It could also used by our visual non-regression testing tool.

It could start with a simple page, and be improved step by step.
There is also some tools to do it like Style Guide Boilerplate, Pattern Primer or Module Gallery.

Cheers,
Thomas.
mnapoli added a commit that referenced this issue Apr 29, 2015
@mnapoli
#7652 CSS style guide and UI components demo
27e91a2
@mnapoli mnapoli self-assigned this Apr 29, 2015
@mnapoli mnapoli modified the milestones: Piwik 2.13.0, Piwik 2.14.0 Apr 29, 2015
@mnapoli mnapoli added the c: Design / UI For issues that impact Matomo's user interface or the design overall. label Apr 29, 2015
@mnapoli mnapoli mentioned this issue Apr 29, 2015
Merged
@mnapoli
Copy link
Contributor

mnapoli commented Apr 29, 2015

PR: #7787

mnapoli added a commit that referenced this issue Apr 29, 2015
@mnapoli
#7652 CSS style guide and UI components demo
85b861f
mnapoli added a commit that referenced this issue Apr 30, 2015
@mnapoli
#7652 CSS style guide and UI components demo
9992214
@mnapoli
Copy link
Contributor

mnapoli commented May 10, 2015

#7787 has been merged but it only includes a UI test of the demo page. This page is not yet documented, and the CSS classes are not tagged as API yet. Let's discuss that topic here:

  • do we consider as API everything documented in this page?
  • if yes, we need to integrate this into the developer documentation (via widget/iframe maybe…)

@mnapoli mnapoli removed their assignment Jun 8, 2015
@tsteur
Copy link
Member

tsteur commented Jun 9, 2015

do we consider as API everything documented in this page?

I do not really have a huge problem with considering everything API but would prefer not to. Eg we have a PHP & JS API for notifications so developers do not really need to know the markup for notifications. Not having it API would just leave us more flexibility in changing things in the future as we will want to change things in the future again for sure. Eg maybe we want to use another UI framework (based on AngularJS, eg https://material.angularjs.org/latest/#/demo/material.components.autocomplete only an example) and there notifications etc are made completely different. It's rather a random example though. I'm ok with it as long as we're careful what we put on that page.

@mattab
Copy link
Member

mattab commented Jun 16, 2015

Could this issue be closed for 2.14.0? if not, let's move it to 3.0.0 and write here the next step / decision.

@mnapoli
Copy link
Contributor

mnapoli commented Jun 16, 2015

This issue isn't done, I'm moving it to 3.0.

@mnapoli mnapoli modified the milestones: 3.0.0, 2.14.0 Jun 16, 2015
@mattab mattab modified the milestones: 3.0.0-b3, 3.0.0 Feb 8, 2016
@mattab
Copy link
Member

mattab commented Feb 8, 2016

we now have a "Demo page" listing CSS styles that are "Api" so the remaining step is to advertise this publicly on developer.piwik.org

@tzi
Copy link
Member Author

tzi commented Feb 9, 2016

Hi! Is this page public yet?

@tsteur
Copy link
Member

tsteur commented Feb 10, 2016

Nope, not yet. Need to find a way to make it public somehow. Currently the page needs some admin access + enabled development mode

@mattab mattab modified the milestones: 3.0.0-b3, 3.0.0-b4 Nov 14, 2016
@mattab mattab modified the milestones: 3.0.0-b5, 3.0.0-b4, 3.0.0 Dec 1, 2016
@mattab mattab added the c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. label Dec 5, 2016
@mattab mattab modified the milestones: 3.0.5, Priority Backlog (Help wanted) May 16, 2017
@mattab mattab mentioned this issue May 16, 2017
Closed
@mattab mattab modified the milestones: 3.0.5, 3.1.0 Jul 12, 2017
@spacenate spacenate mentioned this issue Oct 30, 2017
Merged
@mattab mattab modified the milestones: 3.3.0, Backlog (Help wanted) Dec 14, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c: Design / UI For issues that impact Matomo's user interface or the design overall. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself.
Projects
None yet
Milestone
Backlog (Help wanted)
Development

No branches or pull requests
4 participants
@tsteur @tzi @mattab @mnapoli