Adds the possibility for GLPI users to discover features with short tutorials

[ccailly]

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets

Adds a discovery system for GLPI functionalities.

[AdrienClairembault]

I think some changes targeting the /locales directory were maybe commited by mistake ?

[AdrienClairembault]

Functional review :

1. The default lesson should not be triggered on the install page
   

2. It would be nice if the last step of the default lesson would show you the menu entry to access all lessons.

3. When a lesson is finished, maybe add a final step that confirm the lesson is over and display a link to go to the lessons page ?

4. If I keep the main lesson page open in browser tab A, then complete one of the lessons in browser tab B and finally try to run the same lesson from tab A (where its still marked as "not done" because I haven't refreshed the page) I get a blank page.
   Maybe in this case allow the user to run the lesson again even if its finished to avoid the error ?

5. I can still scroll on the page when the modals are displayed.
   It feels a bit weird and I'm not sure if it's supposed to work this way.
   Is it done on purpose by the intro.js lib and/or is there an option to disable scrolling ?
   For example bootstrap modals forbid body scrolling by default:
   

6. Lessons are still available for all users but you end up with a blank page when trying to start a lesson if you are not super-admin.
   I think we could disable the "My lessons" menu entry for non super-admin users for now ?

7. UI / UX is very good 👍, I still have a few minimal ajustements in mind but I think its best we wait till all the features are implemented before nitpicking on small details ;)

[AdrienClairembault]

Note: don't forget we need a temporary branch to merge into as we want to split the development into multiple PRs.

Can somebody with write permission create the branch so we can rebase the PR onto it ?

[AdrienClairembault]

Lint is not OK, can you check when you come back @ccailly ?

[orthagh]

Tests of the days:

• lessons repo was not up to date, error reported in logs:

[2024-01-29 14:56:56] glpiphplog.CRITICAL:   *** Uncaught Exception TypeError: array_walk_recursive(): Argument #1 ($array) must be of type array, int given in /var/www/html/glpi/main/src/Discover/Discover_User.php at line 146

• After update, it still fails on others lessons on my side, with a log:

[2024-01-29 15:23:18] glpiphplog.WARNING:   *** PHP Warning (2): foreach() argument must be of type array|object, null given in /var/www/html/glpi/main/vendor/twig/twig/src/Extension/CoreExtension.php at line 1695
  Backtrace :
  ...ates/30/30c1f1e67a16ab7ba2732d3d9e17b1db.php:46 twig_array_map()
  vendor/twig/twig/src/Template.php:394              __TwigTemplate_7c863886c16976a0a8246c1a67f306db->doDisplay()
  vendor/twig/twig/src/Template.php:367              Twig\Template->displayWithErrorHandling()
  vendor/twig/twig/src/TemplateWrapper.php:45        Twig\Template->display()
  src/Application/View/TemplateRenderer.php:198      Twig\TemplateWrapper->display()
  src/Discover/Discover.php:75                       Glpi\Application\View\TemplateRenderer->display()
  src/Html.php:1789                                  Glpi\Discover\Discover::loadDiscover()
  front/ticket.php:63                                Html::footer()
  public/index.php:82                                require()

Don't know why the last appears, any hints welcomed.

Regarding the config file in lessons folder, I see this kind of path: "content" => "file://introduction.md",. I suggest to move to file://./sources/introduction.md to permits to click on links in vscode.

[cconard96]

If the lessons are going to be part of the GLPI repo, the translations would benefit from having a context specified.

[orthagh]

good point !

The current lessons are, for the moment, examples of what is possible with the feature.
I pushed the subject to @arthurrschaefer, he should start soon to write (in our outline) articles.

When we will integrate his work, indeed, we should add gettext context.

[AdrienClairembault]

Some lessons content can't be fetched if the locates aren't compiled.

I think in this case we should still be able to display the default (english) content.

Also the compile scripts doesn't seem to work on my side, can you test it again to make sure it is OK ?

[ccailly]

Some lessons content can't be fetched if the locates aren't compiled.

I think in this case we should still be able to display the default (english) content.

Also the compile scripts doesn't seem to work on my side, can you test it again to make sure it is OK ?

I've added a fallback on the sources in case no translation exists.
To run the build script, you need to be in the resources/Lessons folder. This script is temporary and will disappear or be modified.

[AdrienClairembault]

Any updates on this ? Some reviews are still pending.