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

Use generic wording whenever possible #7826

Open
tsteur opened this issue May 4, 2015 · 1 comment
Open

Use generic wording whenever possible #7826

tsteur opened this issue May 4, 2015 · 1 comment
Labels
c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc.

Comments

@tsteur
Copy link
Member

tsteur commented May 4, 2015

As we build a generic analytics solution that can track anything we should use a generic wording whenever possible:

  • Eg "Property" instead of "Website"
  • Eg "Users" instead of "Visitors" (metrics, dimensions)
  • Eg "Sessions by days since last session" instead of "Visits by days since last visit" (reports)
  • Eg nb_sessions instead of nb_visits in API output (this will break the API and might not be possible but long term we have to, maybe in Piwik 4.0)
  • In general we could sometimes use more generic wording. Eg instead of "No websites found" we could use "No matches found"

Please don't think about the actual wording for now. Whether we name it Property or whatever is not important here.

As we still want to have the wording "Website" as before we will need to develop a type "Website" that translates the generic terms into the "Website" terms such as "Visits", "Visitors", ...

If no type is activated or as soon as we deal with multiple types we fall back to a generic wording. Eg if the current Website chooser only contains websites, we use the "Website" wording. If it contains "Websites" and "Mobile Apps" we fall back to the generic wording "Properties".

This will make it much easier for plugin developers to develop a custom type since it would be a lot more work to rename everything if we do not have a generic wording by default and it would be very confusing to translate everything from the type "Website" into another type. Also long term we would need this anyway otherwise we will always have a "hacky" solution.

This issue is a problem since it is kinda required to develop #7131 and #4734 but we cannot develop the type without having #7131 and 4734 implemented. We do not want to have the generic wording at any point in the UI for now so we will need to have a website type developed when working on this. To solve this the generic wording could be a type as well that cannot be disabled. So at some point we just swap the website type with the generic type.

We will most likely create issues for all points mentioned in the above list to go towards this step by step. For now this issue is here to collect ideas how to make it possible, to collect possible problems, solutions etc.

@tsteur tsteur added Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. labels May 4, 2015
@mattab mattab modified the milestones: Short term, 3.0.0 Jul 15, 2015
@mattab
Copy link
Member

mattab commented Aug 13, 2015

The idea is to have generic wording in Piwik core, that will work well for Websites, Apps, Intranets, etc.

Later on plugins will be able to rename each of these metrics, for example for Car analytics #6776 - see follow up issues:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc.
Projects
None yet
Development

No branches or pull requests

3 participants