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

Make it easier to search help resources from within Matomo #14870

Merged
merged 13 commits into from Sep 18, 2019
Merged

Conversation

katebutler
Copy link

Fixes #14626

@katebutler katebutler added the Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review. label Sep 8, 2019
@katebutler katebutler added this to the 3.13.0 milestone Sep 8, 2019
@katebutler katebutler changed the title Add link to matomo.org resources in awesome search Make it easier to search help resources from within Matomo Sep 8, 2019
<li class="quick-access-category helpCategory">{{ 'General_HelpResources' | translate }}</li>
<li ng-class="{selected: search.index == 'help'}"
ng-mouseenter="search.index='help'">
<a href="https://matomo.org?s={{ urlEncode(search.term) }}" target="_blank">Search '{{ search.term }}' on matomo.org</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@katebutler this string needs to be translatable... like {{ 'foobar_xyz'|translate:search.term }}

<li class="quick-access-category helpCategory">{{ 'General_HelpResources' | translate }}</li>
<li ng-class="{selected: search.index == 'help'}"
ng-mouseenter="search.index='help'">
<a href="https://matomo.org?s={{ urlEncode(search.term) }}" target="_blank">Search '{{ search.term }}' on matomo.org</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might also need to check if ng-href is a better fit. Might be more secure and might not need the urlencode then. Not 100% sure though but think so

@katebutler katebutler added Needs Review PRs that need a code review and removed Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review. labels Sep 10, 2019
@@ -36,5 +36,13 @@
ng-click="quickAccess.selectSite(site.idsite)"
ng-repeat="site in quickAccess.sitesModel.sites"><a ng-bind="site.name"></a></li>
</ul>
<ul>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@katebutler could wee add a CSS class quickAccessMatomoSearch here (or similar name) then we can disable this maybe through whitelabel when needed.

<div class="search-matomo-form">
<div>
<span class="icon-search"></span>
<input type="text" placeholder="{{'Feedback_SearchHelpResources'|translate|e('html_attr')}}" name="s"/>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't using our form widgets like <div piwik-field uicontrol="text"....>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might need also generally need to look more like a search field maybe like but with the icon on the left
image

BTW we're using MaterializeCSS see http://archives.materializecss.com/0.100.2/shadow.html so we could use classes like z-depth-1. If we make the search look like above we would maybe not need to reuse our builtin widgets.

In general be good to improve the look a bit. Could we maybe make it look like this?

image (the search icon needs to be vertically centered)

@@ -8,6 +8,24 @@
{% block content %}

<div id="feedback-faq" class="admin">
<div piwik-content-block content-title="{{ "Feedback_HowCanWeHelp"|translate|e('html_attr') }}" class="feedback-help-resources">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reckon be good to move this section under "About Matomo".

We then need to see how to further optimise it as there will be three different help sections... Community help also partially repeats the guides and FAQs. People might not notice the community help and professional help section when we show the "how can we help" section...
image

@katebutler
could you merge the three sections into one section similar to this?
image

@tsteur tsteur merged commit f697570 into 3.x-dev Sep 18, 2019
@tsteur tsteur deleted the 14626 branch September 18, 2019 22:00
@mattab mattab added the not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. label Oct 25, 2019
@mattab mattab modified the milestones: 3.13.0, 3.12.0 Oct 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Review PRs that need a code review not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make it easy to search Matomo.org user guides and FAQs within the app
3 participants