1.
Guided Tours
Providing tutorials for new users

2.
Agenda
What are Guided Tours
Setting up tours
Creating a custom tour

3.
Key Benefits
New to Rundeck policies and procedures
• Document runbooks/policies
• Help job runners and viewers
navigate Rundeck
• Provide guidance to new job
writers

4.
Key Features
Provide instructions within the Rundeck interface
• Integrated content
• Ability to highlight menus
• Provide navigation

5.
Enable Tours
Provide instructions and guidance to new and current users
• Install or Download plugin
• - HTTP Tours
• - Embedded Tours
• Configure tour directory
• - framework - any page
• - project - only if selected
• Create tour files
• Deploy tour files
• - Web host (S3 bucket)
• - Local directory

6.
Writing a Tour
Tour components
• Manifest
• Tours
•

7.
Manifest file
JSON file format
● name - Tour title
● tours - Catalog of available page files
● name - Display name of the tour
● key - Pages file name
{
"name": "Title of tour",
"tours": [
{
"key": "file-name-without-ext",
"name": "Tour name"
}
]
}

8.
Pages
JSON format
● Name: Title
● Key: File name without ext
● Steps: Pages of tour
○ Title: Page name
○ Content: HTML displayed on page
○ NextStepURL: Rundeck page to
display when the user clicks next
○ stepIndicator: Named element on
the page
{
"name": "Securing sensitive data",
"key": "sensitive-data",
"steps": [
{
"title": "Overview",
"content":
"<!--n-->n<p>nn</p>n<h6>Next, creating
keys</h6>nn",
"nextStepUrl": "menu/storage"
"stepIndicator": "appUser"
},...]}

9.
Questions?