Feature Overview

Guided Tours are a mechanism we can use to vastly improve our customer's initial user experience and will help customers with the dreaded "empty cluster". There are a number of newer enhancements that have been added to the console which require prior knowledge to either discover the feature or configure it or both. Guided tours will help customers discover and configure new features to hopefully increase overall use of OpenShift.

• Improve the Initial User Experience - Addressing Empty Cluster
• Improve Discoverability - Highlighting High Value Services
• Educate Users - Teaching users concepts like Operators, Admin\Developer Perspective, Running Applications, Setting Up Infrastructure, etc..

Goals

Our goals would be to...

1. Educate users on how to maximize usage of the UI
2. Help customers to discover and enable value added services
3. Reduce the time it takes to get customers up and running
4. Increases workloads running on the cluster

Requirements

High Level

• Tours must be extensible
• Two types of tours:
  • Enable & Consume a Service( ie. Install Serverless Operator then deploy a showcase Serverless App)
  • Consume a Service ( ie. Deploy a showcase Serverless app)
• Tours should be easy to cleanup

Guided Tours

• Guided tours must be extensible by other product teams at Red Hat to enable their services on the cluster
  • Pre Operator Install. Want the ability to deliver these off release cadence
• Guided tours must be extensible with Operators
  • Operator is already enabled, add guided tour for consuming service
• Guided tours will be provided and maintained by each product team and or Operators

Format of Guided Tours (Almost like Interactive Documentation)

• Markup language
• Made up of Long Description, Steps, Links(Internal, External)
  • 1 step per page. User navigates to the next page by clicking a button
  • A tour may offer a link to a secondary tour
  • A tour may offer an external link to documentation, etc
• Progress indicator, indicating the number of steps in the tour

Tour information to be displayed on the Cards in the landing page

• Title
• Summary (aka Short Desc)
• Image
• Approx time
• Indication if already completed (local storage, maybe this is punted til User Pref)

Admin configuration of Guided Tours

• Guided tours must have a mechanism to disable them(Show\Hide)
  • Admins should be able to configure which tours are available on the cluster

Tours available in Admin Perspective

• Admin perspective should have it’s own guided tour launch\landing page
• Each Guided tours should indicate its completion status (per user, local storage)
• Guided tour landing pages should be sortable and filterable by the completion status
  • Users should be able to sort/filter by if they have completed a tour before
  • Hide what i’ve done, or put it at the end of the list
• Guided tours should be broken up into 2 parts: enable a service, consume service.
  • the first tour should allow the admin to take the 2nd tour immediately afterwards
• Guided tours for consume service should only be available once the service has been enabled
  Aka once operator is installed and configured

Tours available in Dev Perspective

• Developer perspective should have it’s own guided tour launch\landing page, focused on consuming services
• Each Guided tours should indicate its completion status (per user, local storage)
• Guided tour landing pages should be sortable and filterable by the completion status
  • users should be able to sort/filter by if they have completed a tour before
  • Hide what i’ve done, or put it at the end of the list
• Guided tours must have a mechanism to clean up the resources it created
  • the tour prompts the user to either delete the application or the project

Potential Tours

• Serveless
• Pipeline
• OCS
• CNV
• Using custom metrics

(Optional) Use Cases
<--- Remove this text when creating a Feature in Jira, only for reference --->
* Main success scenarios - high-level user stories
* Alternate flow/scenarios - high-level user stories
* ...

Issues/Questions to answer...
How will the user interact with this feature?
Which users will use this and when will they use it?
Is this feature used as part of the current user interface?
We can’t assume that all users can create projects during these tours

Out of Scope
<--- Remove this text when creating a Feature in Jira, only for reference --->
# List of non-requirements or things not included in this feature
# ...

Background, and strategic fit

• Key OKRs are to provide an exceptional initial user experience and to drive increase of workloads. This feature address both.

Assumptions

• Each product team will create an Epic to contribute a guided tour

Customer Considerations

• This needs to work in Air-gapped environments

Documentation Considerations
<--- Remove this text when creating a Feature in Jira, only for reference --->
Questions to be addressed:
* What educational or reference material (docs) is required to support this product feature? For users/admins? Other functions (security officers, etc)?
* Does this feature have doc impact?
* New Content, Updates to existing content, Release Note, or No Doc Impact
* If unsure and no Technical Writer is available, please contact Content Strategy.
* What concepts do customers need to understand to be successful in [action]?
* How do we expect customers will use the feature? For what purpose(s)?
* What reference material might a customer want/need to complete [action]?
* Is there source material that can be used as reference for the Technical Writer in writing the content? If yes, please link if available.
* What is the doc impact (New Content, Updates to existing content, or Release Note)?