firstrunwizard icon indicating copy to clipboard operation
firstrunwizard copied to clipboard

Replace shipped slides with custom slides

Open wiswedel opened this issue 4 years ago • 10 comments

Service Owners of large Nextcloud installations would appreciate being able to onboard their users with more tailored slides.

The shipped slides focus on the Nextcloud project, its own values its interoperability. However, in an enterprise environment, there are usually other topics important like custom documentation, first steps how to use the platform, support contacts etc.

It would be good to have the ability to create custom slides to replace the shipped ones. Their format may be discussed further.

Bonus: Those slides' order would even be tailorable to user groups.

wiswedel avatar Jan 29 '21 18:01 wiswedel

This is already somewhat possible with a custom theme where you place the individual contents of the page.* templates in https://github.com/nextcloud/firstrunwizard/tree/master/templates into themes/yourtheme/apps/firstrunwizard/templates

Definitely not the most elegant and flexible solution but should work for the most use cases.

The intro video slide is not cutomizable through that but can be disabled with removing it from the slide list with the following config:

occ config:app:set firstrunwizard slides --value="values,apps,clients,final"

We can of course think about moving this towards a nicer technical solution, but we'd need to know more about the actual requirements for that then especially to know if there are cases which are not achievable with the current way.

juliusknorr avatar Feb 01 '21 10:02 juliusknorr

Thanks for the workaround suggestion, @juliushaertl.

My tests with that approach only allow me to customize within the above mentioned set of slides. I cannot add a 5th, 6th and 7th slide with different names, can I?

Also: Isn't the themes folder approach deprecated generally and shouldn't be used anymore?

wiswedel avatar Feb 01 '21 10:02 wiswedel

My tests with that approach only allow me to customize within the above mentioned set of slides. I cannot add a 5th, 6th and 7th slide with different names, can I?

No that would be a limitation currently.

Also: Isn't the themes folder approach deprecated generally and shouldn't be used anymore?

Yes, though we have not dropped it yet as we currently don't have a replacement for advanced customization like replacing language strings or the mentioned template replacement.

juliusknorr avatar Feb 01 '21 11:02 juliusknorr

Yes, though we have not dropped it yet

Makes it no longer safe for production anyway

wiswedel avatar Feb 01 '21 11:02 wiswedel

As long as the video url doesn't change, you may want to replace the video update safe with an alias directive in your webserver config e.g. in your apache vhost config:

Alias "/apps/firstrunwizard/img/Nextcloud.webm" "/var/www/nextcloud/nextcloud-adjustments/apps/firstrunwizard/img/mybrand.webm"
Alias "/apps/firstrunwizard/img/Nextcloud.mp4" "/var/www/nextcloud/nextcloud-adjustments/apps/firstrunwizard/img/mybrand.mp4"

ghost avatar May 05 '21 15:05 ghost

Quick idea for implementing this:

  • Add an event that is dispatched during the slide building
    • The event allows to set custom slides with their HTML content
    • The event allows to set a custom url for a intro video
  • A 3rdparty app could then listen to the event and do the customization

https://github.com/nextcloud/firstrunwizard/compare/master...enh/customslides

juliusknorr avatar Jun 07 '22 19:06 juliusknorr

@juliushaertl is https://github.com/nextcloud/firstrunwizard/compare/master...enh/customslides ready to get merged or is something still missing?

szaimen avatar Mar 29 '23 09:03 szaimen

I don't fully remember, proably some code polishing but I don't see to have time for that currently.

juliusknorr avatar Mar 29 '23 09:03 juliusknorr

All right, thanks for the answer! :)

szaimen avatar Mar 29 '23 09:03 szaimen

Hello there :wave: Thanks for the work ! This is quite an old issue now, sorry to revive this. Is there any way to add extra/custom slides now by any chance ?

keomabrun avatar Nov 24 '23 17:11 keomabrun