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

Display help icons for categories/subcategories #14095

Closed
wants to merge 774 commits into from
Closed

Conversation

diosmosis
Copy link
Member

Fixes #13716

@diosmosis diosmosis added Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review. not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. labels Feb 13, 2019
@diosmosis diosmosis added this to the 3.9.0 milestone Feb 13, 2019
@diosmosis
Copy link
Member Author

@mattab could you try this PR locally and see if the UX works for you: #14095 ?

@mattab
Copy link
Member

mattab commented Mar 15, 2019

Like where this is going!
Feedback:

  • add a useful tooltip displayed on hover on the icon (after the standard delay) like `
  • only show the icon when the mouse is within the submenu's row, or when the help notification is visible. Otherwise hide the icon to not clutter when browsing reports.
  • when notification is displayed and then the icon is clicked, hide the help notification
  • when a custom dashboard is loaded, show the notification at the top
  • if we have other icons with a grey (not black) tone, this could work but maybe it's fine in black...

To make this feature happen we also need to draft a description text for each page, a short text that introduces the page and makes it shine. For example consistently mention what info is there, why it is important and valuable (what problems does it solve, benefits does it bring), where to learn more (link to the user guide, the video), this in maybe 1-3 lines/paragraph. (Maybe you can try draft a few of these in the next round but not required)

@tsteur
Copy link
Member

tsteur commented Mar 15, 2019

Personally, I'm finding the icon a bit disturbing. Maybe it's better in a light grey though. Maybe, we could spin this a bit further how we could give a lot more insights with even more content than just 2-3 lines but actually train people and give them a bit more insights like on the pages Marketing is currently working on. Just a random thought.

I know it'll be hard though to find possibly a better solution that isn't always shown. Maybe the icon could also be only shown when hovering that main menu item.

Be maybe also good to check if we find maybe some solutions how other tools did it? (if there are some)

@diosmosis
Copy link
Member Author

@tsteur I saw this sort of intro tutorial a while ago:

image (2)

image (3)

I thought something like this could be used on demo.matomo.org to sell matomo & premium features (by, eg, pointing to data and reports in the demo and adding some context, plus interactively showing off certain features). Perhaps this sort of technique could also be used to show people around matomo the first time (so instead of some help text, we have a toggle-able tour?). It might not be as interesting w/o any data, however.

@diosmosis
Copy link
Member Author

diosmosis commented Mar 15, 2019

If we need data, perhaps we can create an open source version of the demo data feature, by maybe creating a smaller demo data set and using a dump of the database. We'd have to securely download it, which might be a bit of work, and make sure we can insert it even after someone starts tracking.

Edit: I think a tour could do a lot of interesting and different things based on the specific context.

@diosmosis
Copy link
Member Author

We could always link to the pages in the help text as well.

@tsteur
Copy link
Member

tsteur commented Mar 18, 2019

@diosmosis personally I don't like these tours but that's just me. Whenever I see one of those, I usually skip them and don't read them. I just wanna get started and use the tool etc. The problem is also that it shows you tips/tour for things I don't even know yet at this stage, and don't even want to use at that stage. And by the time I want to use that feature, I forgot what the text in the intro said about the feature etc. I believe those intro notifications only work for things when you want a user to take one or two specific actions after logging in for the first time. It's quite good for that. Like click here to create a new user and then click here to create a new website or click here to upload xyz (just a random example).

I like the look of them though. They look great.

@diosmosis
Copy link
Member Author

@tsteur I usually skip those too. I also skim short pieces of text and skip longer text blocks. But we might not be the right users to think about, since we're pretty tech savvy, no?

The main idea I was thinking of was that some kind of set of text bubbles that pointed to features (displayed one at a time like a tour or all at once), would be better than a wall of text. Users could skim over and find what they need, and re-toggle the help when they need to get back to it. The background could be dimmed to make the bubbles more visible.

The simplest approach would be to have one or two sentence description and a link to the content page. We might also want to measure on cloud how many people actually click through.

@mattab mattab modified the milestones: 3.9.0, 3.10.0 Mar 18, 2019
@mattab
Copy link
Member

mattab commented Mar 19, 2019

Quite like the direction of what this PR does (with the top notificaiton for the whole page), assuming with a lighter icon the visual side is acceptable? To be confirmed.

Maybe, we could spin this a bit further how we could give a lot more insights with even more content than just 2-3 lines but actually train people and give them a bit more insights like on the pages Marketing is currently working on. Just a random thought.

That would be great... maybe we could try (over the next few weeks) to create/draft this insightful content for a couple of pages and see what works (size, content) to help users leverage the full potential of the data on each page?

@mattab mattab modified the milestones: 3.10.0, 3.11.0 Mar 27, 2019
@mattab mattab added the Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. label Apr 1, 2019
sgiehl and others added 8 commits October 29, 2020 10:44
…th… (#16595)

* Add new INI config [General] enable_framed_allow_write_admin_token_auth to allow framed matomo use case to still function in Matomo 4.

* Link to faq in exception message.

* apply pr feedback and write integration tests (not passing)

* fix test

* fix test

* update screenshot

* fix more ui tests

* update exception message

* update some expected screenshots

* update screenshot

Co-authored-by: Thomas Steur <tsteur@users.noreply.github.com>
* updates expected test files

* fix ui test
sgiehl and others added 26 commits December 23, 2020 21:21
* Use timezone in period factory only for magic keywords

* add test

* use better timezone

* add non-timezone date

Co-authored-by: diosmosis <diosmosis@users.noreply.github.com>
* Add imprint URL to Template.pageFooter

* Remove German translation

Co-authored-by: diosmosis <diosmosis@users.noreply.github.com>
* Assume hidden keywords to be available by default

* adds a simple system test
…16971)

* Limit max execution time of archiving queries to 2 hours

* Adds test for max execution time

* cast config value to float

* updates expected UI files

* update screenshots

Co-authored-by: diosmosis <diosmosis@users.noreply.github.com>
Co-authored-by: Christian Schmidt <c960657@users.noreply.github.com>
* always send an "Accept-Encoding" header with HTTP requests

* revert unrelated change

* only use CURLOPT_ENCODING when not getting a range of bytes (so tests will pass)

Co-authored-by: diosmosis <diosmosis@users.noreply.github.com>
* add href in link in update message email

* add href in link in update message email

* code review: secure host in url
…ng plugins (#16849)

* Don't accept files that are bigger than the upload limit when uploading plugins

* improve / simplify code

* adds some tests
* Ensure unescaped commas are used for periods in url param

* find root cause and fix (date was being double encoded when being set initially because broadcast does not urldecode but $.param expects urldecoded value)

Co-authored-by: diosmosis <diosmosis@users.noreply.github.com>
)

* Add regular expression support to list of user agents to exclude

- Added regex support to Administration -> Websites -> Settings ->
Global list of user agents to exclude
- Made sure old tests that use stripos() pass
- Added new tests
- Added a sentence to the inline help area about regex support
- Fixed a typo elsewhere as specified in the original issue.

Closes #14186.

Updated method and tests following code review

Update plugins/WebsiteMeasurable/MeasurableSettings.php

Co-authored-by: Stefan Giehl <stefan@matomo.org>

Update system tests

* Update screenshots for UI tests affected by the copy changes
Co-authored-by: tsteur <tsteur@users.noreply.github.com>
* Fix report documentation not shown when switching between related reports

* Adds report documentation for DevicesDetection reports

* Adds some more report documentations

* Adds documentation to Event reports

* Adds documentation to Content reports

* Adds documentation to VisitorFrequency report

* Adds documentation to Goals reports

* Adds documentation to VisitsSummary report

* fixes & test updates

* fix typo

Co-authored-by: Lukas Winkler <git@lw1.at>

* small tweaks to some docs

* revising some of the report documentation

* fix translation file

* updates expected test files

Co-authored-by: Lukas Winkler <git@lw1.at>
Co-authored-by: diosmosis <diosmosis@users.noreply.github.com>
…rSegmentIsInProgress(). (#16996)

* Add unit test for QueueConsumer::shouldSkipArchiveBecauseLowerPeriodOrSegmentIsInProgress().

* move tests to integration
* Make it possible to overwrite metric documentations for sparklines

* Remove metric tooltips for visitsummary sparklines
* Fix limited visits query when sorting ascending

* reactivate test for sorting visits ascending
@diosmosis
Copy link
Member Author

closing this pr since the commit history seems completely borked

@diosmosis diosmosis closed this Jan 8, 2021
@sgiehl sgiehl deleted the 13716-page-help branch January 9, 2024 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Show a message in each most valuable pages in Matomo to explain why it's important