gambitph / Titan-Framework

The easiest to use WordPress option framework.
http://www.titanframework.net
377 stars 138 forks source link

Opt in Tracking #156

Open bfintal opened 10 years ago

bfintal commented 10 years ago

This is so that we can know what sites are using Titan! For showcasing and stats.

Let's put this as opt-in only. The tracking should be done only for the first installation and every week afterwards.

ghost commented 10 years ago

I see an issue with this Benjamin. If we are an agency and build sites for clients, sometimes the sites we build are of delicate nature on them being active. We would not want them to be showcased without consent. I assume that you would ask consent to showcase the work that is using Titan-Fw?

bfintal commented 10 years ago

Yup this can be turned off and is only opt-in. By showcasing it'll mostly be for themes & plugins that use Titan. So that we can know what products use Titan, currently we have no idea on who is using it, or even if the framework is being used at all!

By default it will be turned on, but can be turned off with:

$titan = TitanFramework::getInstance( 'my-theme' );
$titan->set( 'tracking', false );

Although this function isn't final yet. :) If tracking is turned on, we can display a one-time bubble with an opt-in question

ghost commented 10 years ago

Who see's the message? Us as the developer, or the end client? Also I think if you are looking at showcasing the sites, i presume you would only showcase the ones that are approved for showcasing? A scenario would be that we build sites that are quite sensitive of nature in that strictly cannot be showcased, yet don't mind sending stats that they are using the framework.

What are you using for tracking?

On Mon, Aug 4, 2014 at 11:23 AM, Benjamin Intal notifications@github.com wrote:

Yup this can be turned off and is only opt-in. By showcasing it'll mostly be for themes & plugins that use Titan. So that we can know what products use Titan, currently we have no idea on who is using it, or even if the framework is being used at all!

By default it will be turned on, but can be turned off with:

$titan = TitanFramework::getInstance( 'my-theme' ); $titan->set( 'tracking', false );

Although this function isn't final yet. :) If tracking is turned on, we can display a one-time bubble with an opt-in question

— Reply to this email directly or view it on GitHub https://github.com/gambitph/Titan-Framework/issues/156#issuecomment-51010926 .

MickeyKay commented 10 years ago

Hmmm, I do believe that WordPress policy is that all opt-in options have up be OFF by default for plugins and themes.

On Sunday, August 3, 2014, Ciaran Whelan notifications@github.com wrote:

Who see's the message? Us as the developer, or the end client? Also I think if you are looking at showcasing the sites, i presume you would only showcase the ones that are approved for showcasing? A scenario would be that we build sites that are quite sensitive of nature in that strictly cannot be showcased, yet don't mind sending stats that they are using the framework.

What are you using for tracking?

On Mon, Aug 4, 2014 at 11:23 AM, Benjamin Intal <notifications@github.com javascript:_e(%7B%7D,'cvml','notifications@github.com');> wrote:

Yup this can be turned off and is only opt-in. By showcasing it'll mostly be for themes & plugins that use Titan. So that we can know what products use Titan, currently we have no idea on who is using it, or even if the framework is being used at all!

By default it will be turned on, but can be turned off with:

$titan = TitanFramework::getInstance( 'my-theme' ); $titan->set( 'tracking', false );

Although this function isn't final yet. :) If tracking is turned on, we can display a one-time bubble with an opt-in question

Reply to this email directly or view it on GitHub < https://github.com/gambitph/Titan-Framework/issues/156#issuecomment-51010926>

.

Reply to this email directly or view it on GitHub https://github.com/gambitph/Titan-Framework/issues/156#issuecomment-51013960 .

bfintal commented 10 years ago

Really? Redux has it turned on I think.

Basically here's the idea:

If the plugin/theme that has Titan is activated, a one-time bubble popup would show up in the admin (or maybe it'll just be an admin notification) asking the user to opt-in for installation tracking.

If 'yes' is clicked, then it will send server details (url, php details, WP details: version, current theme, activated plugins, Titan version, what plugin/themes are using Titan, etc. Basically general stuff) to a script in titanframework.net that just gathers all of those details. This will be repeated once or twice a week.

If 'no' is clicked, then tracking will be permanently turned off and it won't be asked again.

If tracking was set to false in the code, then it won't be shown at all.

On the titanframework.net side of things, we can display stats like the number of installations, and graphs. Most will not be disclosed such as the specific domains that use TF. But if we notice that a certain plugin or theme has a lot of entries, or maybe if there's an awesome domain (e.g. mcdonalds.com or something), then it might be a good idea to contact the creators or site owners and ask for permission if their product can be showcased in the titanframework.net.

bfintal commented 10 years ago

The main goal essentially is so that everyone can get an idea of whether or not Titan is being used and if it is, then by how much? As mentioned, we have no idea who's using it and how it's being used. We have almost 2,000 downloads in the WP plugin repo, but where are those really? How many use the WP repo plugin, or how many are embedded?

Another practical use is counting the number of containers, options and option types. So if we see that a ton of people are using Titan for meta options, then it might be good to concentrate more features there. And also it might be interesting to know how many installations (or the growth of installations) are using the Theme Customizer.

Or maybe if the number option is super popular, then it may be a good idea to split the number option into more specific option types. e.g. an option type to manipulate width/heights.

bfintal commented 10 years ago

Committed code for tracking. Currently set to off by default.

Still missing a few parts, namely:

Basically we're getting:

Seems harmless enough, no sensitive details like emails or login information :) Plus this will only run once every week via transients.

MickeyKay commented 10 years ago

Awesome, it had previously sounded to me like the opt-in would be turned on by default. As long as it truly is "opt-in" (off by default, requiring the user to take an action to initialize), then it's fine by me! Exciting!

On Sun, Aug 3, 2014 at 11:05 PM, Benjamin Intal notifications@github.com wrote:

Committed code for tracking.

Still missing a few parts, namely:

  • Get the number of admin panels, meta boxes, and theme customizer panels created,
  • Get the number of each type of options created,
  • Implement gathering of tracking data in titanframework.net

Basically we're getting:

  • The current theme details,
  • Activated plugin details,
  • Titan version + option & container stats
  • PHP version,
  • WordPress details

Seems harmless enough :) Plus this will only run once every week via transients.

Reply to this email directly or view it on GitHub https://github.com/gambitph/Titan-Framework/issues/156#issuecomment-51020544 .

bfintal commented 10 years ago

Only thing missing now is to implement the gathering of tracking data in titanframework.net :)

bfintal commented 10 years ago

Off topic: Hey @MickeyKay check out the new workflow at http://www.titanframework.net/get-started/

ghost commented 10 years ago

Benjamin, workflow looks good.

bfintal commented 10 years ago

@cmwwebfx :+1:

MickeyKay commented 10 years ago

Ha ha, the anticipation is killing me :-) Just getting 404 errors for now, but will check back tomorrow.

On Sunday, August 3, 2014, Benjamin Intal notifications@github.com wrote:

Off topic: Hey @MickeyKay https://github.com/MickeyKay check out the new workflow at http://www.titanframework.net/get-started/

Reply to this email directly or view it on GitHub https://github.com/gambitph/Titan-Framework/issues/156#issuecomment-51022452 .

oherman commented 10 years ago

Yeah, titanframework.net is still currently down due to migration issues. Hopefully we'll get that working later.