matomo-org / matomo

Empowering People Ethically with the leading open source alternative to Google Analytics that gives you full control over your data. Matomo lets you easily collect data from websites & apps and visualise this data and extract insights. Privacy is built-in. Liberating Web Analytics. Star us on Github? +1. And we love Pull Requests!

https://matomo.org/

GNU General Public License v3.0

19.66k stars 2.62k forks source link

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

Open tzi opened 9 years ago

tzi commented 9 years ago

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 commented 9 years ago

PR: #7787

mnapoli commented 9 years ago

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…)

tsteur commented 9 years ago

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 commented 9 years ago

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 commented 9 years ago

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

mattab commented 8 years ago

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 commented 8 years ago

Hi! Is this page public yet?

tsteur commented 8 years ago

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