Add widget to help users getting started and complete important steps with Matomo #12468

tsteur · 2018-01-17T20:31:16Z

diosmosis · 2018-06-14T00:07:50Z

@tsteur is this still a WIP or is it ready to review now?

tsteur · 2018-06-14T00:17:09Z

It is WIP

tsteur · 2019-04-17T03:45:51Z

@mattab can you have a look at it? I can add some challenges to Custom Dimensions, Custom Alerts, and other premium features once this has been merged.

tsteur · 2019-04-29T20:24:11Z

ping @mattab

mattab · 2019-06-10T09:38:49Z

@diosmosis can you please review this quickly and merge if it looks good to you? Be good to get it out in 3.10.0 and test it and get early feedback 👍

plugins/Tour/Widgets/GetEngagement.php

diosmosis · 2019-06-11T04:50:39Z

Tour_MatomoTalent is missing a translation.

diosmosis · 2019-06-11T05:05:30Z

Noticed Tour is not enabled in an update. This is expected, correct?

diosmosis · 2019-06-11T05:07:14Z

Small issue, doesn't seem simple to fix: when clicking on a tour task, a new tab is opened. When the task is finished, we don't go back to the dashboard nor does the widget in the dashboard update w/ a check mark. This might be confusing to new users.

diosmosis · 2019-06-11T05:16:58Z

plugins/Tour/Engagement/ChallengeCustomLogo.php

+
+    public function getUrl()
+    {
+        return 'index.php' . Url::getCurrentQueryStringWithParametersModified(array('module' => 'CoreAdminHome', 'action' => 'generalSettings', 'widget' => false)) . '#useCustomLogo';


Angular turns '#useCustomLogo' into '#/useCustomLogo', so it doesn't go to the correct section.

Any thoughts on how to fix this?

Hacky fix might be on page load to check if the hash has no query parameter characters (ie, only the leading '/'), check if there's an element w/ that string as an ID, and if so scroll to it. Not sure how else to do it since the hash is used by angular...

Could use a special query parameter too instead of the hash, like, scrollTo=myelement.

Could use a special query parameter too instead of the hash, like, scrollTo=myelement.

This might be sometimes tricky when other elements are only loaded later through XHR and then rendered later by the time we already long processed scrollTo parameter.

Seems #/#useCustomLogo works. Can you confirm?

plugins/Tour/Engagement/ChallengeDisableBrowserArchiving.php

diosmosis · 2019-06-11T05:28:40Z

plugins/Tour/Engagement/ChallengeSelectDateRange.php

+
+use Piwik\Piwik;
+
+class ChallengeSelectDateRange extends Challenge


If I select a date range in the dashboard, the page will reload, but the task won't be finished in the widget. If I reload the widget, it will show as finished.

Yes that's kind of expected unfortunately, hard to fix and not worth it spending too much time on it.

plugins/Tour/Engagement/ChallengeBrowseMarketplace.php

diosmosis · 2019-06-11T05:53:06Z

Found some issues while testing, code looks ok but I didn't have time to look thoroughly.

tsteur · 2019-06-11T08:52:51Z

Small issue, doesn't seem simple to fix: when clicking on a tour task, a new tab is opened. When the task is finished, we don't go back to the dashboard nor does the widget in the dashboard update w/ a check mark. This might be confusing to new users.

I'll listen to window focus and update the widget in that case.

Fixed all the other issues you mention including translation, update, ... Except for the link to #customLogo .

diosmosis · 2019-06-11T10:26:36Z

I'll listen to window focus and update the widget in that case.

👍 nice idea, super simple

diosmosis · 2019-06-12T06:32:23Z

one more product related comment: I think there's an issue w/ referring to the user as beginner/expert, since that implies we're teaching them about analytics, not just where certain features in the app are. Eg, adding a goal doesn't necessarily mean the user knows how best to use one, and a user will know that when we call them an expert.

Either the tour is something like "here are some of matomo's most useful features/here is how to get the most out of matomo" or "here is how you use this tool to better your business (and be an expert in analytics)" which is a much harder thing to deliver.

tsteur · 2019-06-12T09:40:43Z

It's certainly meant more for "Here are some of matomo's most useful features/here is how to get the most out of matomo". That's why I was prefixing expert etc with "Matomo Expert" and "Matomo Professional" and "Matomo Beginner"... and not just "Professional" or "Analytics Professional". Does this maybe help?

diosmosis · 2019-06-12T10:16:40Z

"Expert" just suggests the user will be an expert in using matomo after doing those tasks, and I doubt anyone new to the tool will actually feel that way. Which may not be the best experience.

mattab · 2019-06-18T02:46:49Z

Great feature and looking forward to seeing it help people get started complete the most important steps! 👍

Agreed that the naming is currently not ideal, and we'll likely change the names of the levels soon. But will merge already so we can proceed with the release, and will create a new issue once I can think of better names (any suggestion welcome!).
(Maybe a star system 1-5 stars that look good/positive at whever level people are at.)

katebutler · 2019-06-18T21:18:45Z

Have generated expected files for the system tests.

mattab · 2019-06-18T22:05:40Z

@tsteur could you investigate this build failure:

1) Piwik\Plugins\Tour\tests\System\APITest::testApi with data set #0 (array('Tour.getLevel', 'Tour.getChallenges'), array(1))
Piwik\Plugins\Tour\tests\System\APITest: Differences with expected in '/home/travis/build/matomo-org/matomo/plugins/Tour/tests/System/processed/test___Tour.getChallenges.xml'
Failed asserting that two DOM documents are equal.
--- Expected
+++ Actual
@@ @@
     <isSkipped>0</isSkipped>
-    <url>index.php?module=CoreAdminHome&amp;action=generalSettings#useCustomLogo</url>
+    <url>index.php?module=CoreAdminHome&amp;action=generalSettings#/#useCustomLogo</url>
   </row>
   <row>

I will merge anyway in the meantime

added Tour plugin

5ba5979

tsteur added the Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review. label Jan 17, 2018

tsteur added 2 commits January 18, 2018 11:43

enable tour plugin by default

c40701b

better logic to handle steps

a90653c

mattab added this to the 3.3.1 milestone Jan 18, 2018

mattab modified the milestones: 3.4.0, 3.4.1 Mar 22, 2018

mattab added Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc. c: Usability For issues that let users achieve a defined goal more effectively or efficiently. labels Mar 22, 2018

mattab modified the milestones: 3.5.0, 3.6.0 Apr 12, 2018

mattab modified the milestones: 3.6.0, 3.7.0 Jun 14, 2018

mattab modified the milestones: 3.8.0, 3.9.0 Dec 31, 2018

mattab added the Needs Review PRs that need a code review label Dec 31, 2018

mattab modified the milestones: 3.9.0, 3.10.0 Mar 18, 2019

tsteur added 8 commits April 15, 2019 12:33

Merge branch '3.x-dev' into tour

8a239ab

refactor plugin, add more steps

9843855

lots more code improvements, ui improvements, translations, challenges

e2db7f8

lots of more improvements

fd60f5f

adding more challenges

ca4c629

improve detection

7240ca5

more tweaks and tests

4377da8

a few more tweaks

73e85aa

tsteur removed the Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review. label Apr 17, 2019

tsteur added 2 commits April 23, 2019 12:34

update some wordings

7abb9f2

switch two levels talent and professional

6af37aa

Merge branch '3.x-dev' into tour

18aa570

mattab requested a review from diosmosis June 11, 2019 03:57

Merge branch '3.x-dev' into tour

cd9aa20

diosmosis reviewed Jun 11, 2019

View reviewed changes

plugins/Tour/Widgets/GetEngagement.php Outdated Show resolved Hide resolved

diosmosis reviewed Jun 11, 2019

View reviewed changes

plugins/Tour/Engagement/ChallengeDisableBrowserArchiving.php Show resolved Hide resolved

diosmosis reviewed Jun 11, 2019

View reviewed changes

plugins/Tour/Engagement/ChallengeBrowseMarketplace.php Show resolved Hide resolved

apply review feedback

db01795

Update ChallengeCustomLogo.php

11ae147

Expected files for system tests

2610a04

mattab merged commit b3555e1 into 3.x-dev Jun 18, 2019

mattab deleted the tour branch June 18, 2019 22:05

mattab mentioned this pull request Jun 18, 2019

Help users getting started and complete important steps with Matomo #12467

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add widget to help users getting started and complete important steps with Matomo #12468

Add widget to help users getting started and complete important steps with Matomo #12468

tsteur commented Jan 17, 2018 •

edited

Loading

diosmosis commented Jun 14, 2018

tsteur commented Jun 14, 2018

tsteur commented Apr 17, 2019

tsteur commented Apr 29, 2019

mattab commented Jun 10, 2019

diosmosis commented Jun 11, 2019

diosmosis commented Jun 11, 2019

diosmosis commented Jun 11, 2019

diosmosis Jun 11, 2019

tsteur Jun 11, 2019

diosmosis Jun 11, 2019

tsteur Jun 11, 2019

diosmosis Jun 11, 2019

tsteur Jun 11, 2019

diosmosis commented Jun 11, 2019

tsteur commented Jun 11, 2019

diosmosis commented Jun 11, 2019

diosmosis commented Jun 12, 2019

tsteur commented Jun 12, 2019

diosmosis commented Jun 12, 2019

mattab commented Jun 18, 2019

katebutler commented Jun 18, 2019

mattab commented Jun 18, 2019


		use Piwik\Piwik;

		class ChallengeSelectDateRange extends Challenge

Add widget to help users getting started and complete important steps with Matomo #12468

Add widget to help users getting started and complete important steps with Matomo #12468

Conversation

tsteur commented Jan 17, 2018 • edited Loading

diosmosis commented Jun 14, 2018

tsteur commented Jun 14, 2018

tsteur commented Apr 17, 2019

tsteur commented Apr 29, 2019

mattab commented Jun 10, 2019

diosmosis commented Jun 11, 2019

diosmosis commented Jun 11, 2019

diosmosis commented Jun 11, 2019

diosmosis Jun 11, 2019

Choose a reason for hiding this comment

tsteur Jun 11, 2019

Choose a reason for hiding this comment

diosmosis Jun 11, 2019

Choose a reason for hiding this comment

tsteur Jun 11, 2019

Choose a reason for hiding this comment

diosmosis Jun 11, 2019

Choose a reason for hiding this comment

tsteur Jun 11, 2019

Choose a reason for hiding this comment

diosmosis commented Jun 11, 2019

tsteur commented Jun 11, 2019

diosmosis commented Jun 11, 2019

diosmosis commented Jun 12, 2019

tsteur commented Jun 12, 2019

diosmosis commented Jun 12, 2019

mattab commented Jun 18, 2019

katebutler commented Jun 18, 2019

mattab commented Jun 18, 2019

tsteur commented Jan 17, 2018 •

edited

Loading