Popup-Maker
Popup-Maker copied to clipboard
Add Help Scout beacon inside of plugin
Since we are heavily utilizing Help Scout, it makes sense to add the beacon within the plugin itself so users can quickly search documentation that is tailored to the specific settings/sections they are currently viewing.
@danieliser We started discussing the beacon idea over in #912. In there, we were considering having a "Need Help?" or "?
" type link for each section that would open the beacon with common documentation about that section.
We could do that or we could have a ?
on each item (triggers and cookies) which each opens a specific documentation page in the beacon.
Alternatively (or additionally), we could have the floating button with "Get Help" or similar in the bottom corner of our admin pages similar to on our website.
Do you have any thoughts on the way we utilize beacons?
@fpcorso I planned to model it after how WP Rocket was already doing it. Some fields have ? and that links to the relevant doc for that field.
We can probably do more with it as well like messaging at some future point.
@danieliser Okay, so for referene as we work on this issue, here is a screenshot of the WP Rocket setup:
Each of the "Need Help?" links open the beacon to show articles relevant to that section. For example, clicking the "Need Help" for the mobile cache opens this:
That said, we have a few questions to answer still:
- Should there be a support form in the beacon? WP Rocket does. Doing so would make it more likely they ask for support before removing the plugin but it may also lead to more support and wouldn't be as filtered as using our custom support forms on the site.
- For most of WP Rocket's settings, they only have the "Need Help" per section. For example, the "CSS Files" section has 4 settings but only one "Need Help" link. Should we use the same philosophy and have the one help link for the triggers tab, targeting tab, etc.. which opens relevant articles to that tab?
- A lot of our documentation right now is all lumped into single pages for all settings in a tab/section. If we are opening the beacon within the plugin, should we plan to break the documentation down into easier-to-read documentation that is focused on a specific setting/concept to make it easier to show the right info right away in the beacon?
Something more to look at afterwards is implementing the docs into our own site and using this plugin from Yoast to simply ahve the HS docs redirect to our own site: https://github.com/Yoast/helpscout-docs-api
Since we are considering moving docs in the house we need to test the efficacy of Beacon with that solution. Specifically, will it load content for redirected docs? Punting for later.