[Plugin] tour

[h7kanna]

Summary

There should be plugin to enable backstage feature tours with configurable steps and customization.

Project website (if applicable)

A quick search shows multiple libraries which provide configurable feature tour functionality Few of them.

• https://shepherdjs.dev/. (https://github.com/shipshapecode/shepherd)
• https://introjs.com/docs/examples/basic/hello-world (https://github.com/usablica/intro.js)

Context

For new team members getting used to Backstage devportal, this could be very helpful.

Possible way to expose the configuration: https://github.com/shipshapecode/react-shepherd#steps

[benjdlambert]

This is an interesting library to use - onboarding is something that we're hopefully going to be looking at soon which encapsulates both onboarding from a user perspective, and also onboarding from a contributor or someone writing plugins.

Do you want to have a little play around creating something with one of these libraries and opening a PR for some feedback?

[h7kanna]

Hi, I can create a basic integration and get back on this.

[ericis]

IntroJS license is AGPL, a copyleft license. Since Backstage is used by both open source AND companies, we should stick to non-copyleft licensing. If you're not familiar, if we dropped IntroJS into Backstage, a company upgraded to use it and the company had proprietary plug-ins for their backend integrations, the licensing would force them to open source them. I don't think we want Backstage to be that "pushy" 😉

SheperdJS is MIT. All good there.

[janwright73]

hello - I am new to backstage and browsing potential/future plugin ideas. What about our PatternFly quickstart concept for in app/module learning. Here is our documentation link - https://www.patternfly.org/v4/extensions/quick-starts and a link to a demo application - https://quickstarts.netlify.app/. We found that providing the learning content in a pane/drawer where the user can still interact with the application is a good experience when teaching users how to complete tasks. If you are just looking for a 'Clippy' here is a new UI element experience - I think the referenced libraries are sufficient.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.