laravel-enso/tutorials

Laravel Enso user interface tutorial manager, meant to provide an interactive walk-through of the app's pages and its features

Tutorials

Tutorial management dependency for Laravel Enso.

This package works exclusively within the Enso ecosystem.

The front end assets that utilize this api are present in the ui package.

For live examples and demos, you may visit laravel-enso.com

^{click on the photo to view a short demo in compatible browsers}

Installation, Configuration & Usage

Be sure to check out the full documentation for this package available at docs.laravel-enso.com

Contributions

are welcome. Pull requests are great, but issues are good too.

License

This package is released under the MIT license.

tutorials's Issues

The Bootstrap Tour cookie has changed its location

We need to check the browser's localStorage for the "tour_end": "yes" entry in order to determine if the user is on his first visit on the page or not.

Support localisation

This is a feature request.

Description

Support localisation of tutorial (driver.js) steps

thoughts/options:

1. Handle it (mostly) within TutorialManager (/serverside)

   • cleaner manager structure (f.e. language tabs or sections in the form)
   • less wasted data (help is dynamically loaded, would add a lot of data to the translation json's
   • requires more significant data structure changes

2. Handle it like any other translation (using LocalisationManager)

   • reduced context/more risk of overlap (the same word might translate differently depending on context)
   • separated from tutorial manager (residing under localisation-> edit texts)
   • a lot of extra data in the translation strings .json that will most often not be needed
   • might require driver overrides/extra client-side load (currently tutorial fetches the page's steps & passes the server-side data almost directly to Driver)

I would argue that 1. is the best approach, but I'll leave that up for debate.

move the start tutorial button (?) from the sidebar to the navbar

to have it more easily available

Recent update broke tutorials in forms

This is a bug.

Prerequisites

• Are you running the latest version?
• Are you reporting to the correct repository?
• Did you check the documentation?
• Did you perform a cursory search?

Description

Form elements, despite seemingly receiving a z-index don't appear above the driver.js highlight anymore.
This worked just fine ~ 1 month ago

Steps to Reproduce

1. Create a form
2. Add a tutorial to one of it's fields or buttons (example selectors that should work on any form: form .columns .column:last-of-type .field form .button.is-primary)
3. trigger the tutorial, note that the white background covers up what it's trying to highlight.

Expected behavior

Highlighted element to remain visible

Actual behavior

Highlighted element disappearing (seemingly as if z-index isn't getting applied for some reason)

Tutorials - sql syntax error with PostgreSQL

laravel-enso version 2.1.35, postgresql 9.6

https://github.com/laravel-enso/TutorialManager/blob/7444c3a0f13431241959fe1c52416aefe43de73c/src/app/Http/Controllers/TutorialTableController.php#L20

SQLSTATE[42601]: Syntax error: 7 ERROR: syntax error at or near "`" LINE 2: ...nt, tutorials.title, tutorials.placement, tutorials.`order`, ^ (SQL: select tutorials.id as "dtRowId", permissions.name as permissionName, tutorials.element, tutorials.title, tutorials.placement, tutorials.`order`, tutorials.created_at, tutorials.updated_at from "tutorials" inner join "permissions" on "permissions"."id" = "tutorials"."permission_id" limit 10 offset 0)

Problem is around tutorials.order -> it should be tutorials."order"

Please check, is it a valid syntax for mysql, too, I just focuse on PostgreSQL.