GuideQ Guides
GuideQ is a service that creates step-by-step guides with screenshots. The module "GuideQ guides" starts such a guide for your admin area right from the page it should begin on.
Compatible with:
The module is included in the script package. Install it in the admin area under Modules, then switch it on in its settings.
How this module works
The module shows a widget in the corner of every admin page. Open the page the guide should begin on, open the widget and describe what the guide should show, for example: "Open a comment, approve it and show it in the list". GuideQ then signs in to your admin area, walks through the steps and takes the screenshots. The widget never appears in them.
- Create an API token in GuideQ
- Enter the API token in the module settings
- Start a guide from the widget on any admin page
GuideQ adds your site when you start the first guide. The module proves that the site is yours: the login page of the admin area carries the verification token of GuideQ.
Your login
- For the first guide you enter your admin password in the widget. GuideQ signs in with it and stores it encrypted. It is not stored in the script.
- "GuideQ may change data here": switch this on only if the guide has to save something, such as a new entry. These changes are real. Leave it off to only look around.
Settings
- Show the widget
- API token from GuideQ
- GuideQ address: change it only if you run your own GuideQ. It has to start with https://.
The module page lists the address of your site in GuideQ and the latest guides with their status.