Skip to content

Using Welcome Tour

This guide is for owners and operators who set up the admin onboarding tour, and for anyone who wants to take it again. The welcome tour is a short, step-by-step walkthrough that points new admins at the main areas of the admin. No technical knowledge needed. Every step uses the labels you see on screen.

How to take the welcome tour as a new admin

Section titled “How to take the welcome tour as a new admin”
  1. Sign in and open the admin dashboard.
  2. If the tour is on and you have not dismissed it, it starts on its own and shows the first step.
  3. Read each step, then move forward to the next one. The tour highlights the menu, header tools, sites, pages, media, and the dashboard.
  4. If you would rather not do it now, choose Remind me later to pause it until tomorrow.
A first-time administrator lands on the dashboard that can launch onboarding. A first-time administrator lands on the dashboard that can launch onboarding. A first-time administrator sees the first configured tour step. A first-time administrator sees the first configured tour step.
  1. Open the Welcome tour settings in the admin.
  2. Switch on Enabled. This allows the tour to be shown to admins. Per-user preferences only take effect while this is on.
  3. Save.
A site owner configures the enabled state and tour steps from the extension management surface. A site owner configures the enabled state and tour steps from the extension management surface.

The settings summary shows your getting started checklist and available guided chapters. No guided steps are registered means the checklist works on its own; you do not need to fill in the developer builder. Save any settings changes, then select Preview as me to try the saved sequence using your own roles and access. Preview leaves your saved progress and preferences unchanged.

Open Advanced developer only when you need custom guidance. Add a title, description and an existing local destination. Keys are generated automatically and dragging controls ordering. Destination contains optional resource, selector and chapter details; Audience contains visibility, roles and the new-user window; Appearance contains icons and colours. Use Key and order overrides only when integrating with existing steps. Save, then preview to check targets on their destination pages.

  1. Open the Welcome tour settings and edit the step.
  2. In Roles, enter the role names that should see this step, separated by commas. Leave it empty to show the step to all admins.
  3. Use First-run days to show the step only to recently created accounts. Enter the number of days after a user is created during which the step appears.
  4. Save.
  1. Open Welcome Tour settings and select Restart my tour.
  2. Your guided progress and snooze are cleared, and the first available chapter opens. Other users and contextual tours are unaffected.

How to let a specific user see the tour again

Section titled “How to let a specific user see the tour again”
  1. Go to the user’s account in Users and open their edit form.
  2. Switch on Show welcome tour. This clears dismissal and snooze for that account without resetting completed steps. Restarting progress is a separate personal control.
  3. Save. The next time that user opens the dashboard, the tour is available to them again.
An administrator toggles whether a user should see the welcome tour again from the user edit form. An administrator toggles whether a user should see the welcome tour again from the user edit form.
  • Enabled with a short set of steps. Get the core walkthrough working before you tailor it.
NeedWhat to use
Point new admins at your key screensTour steps with a clear Title and Description
Show some steps only to certain peopleThe step Roles field
Show steps only to brand-new accountsThe step First-run days field
Let someone retake the walkthroughRestart tour, or Show welcome tour on their account
RoleFirst useful screen
New adminThe dashboard: take the tour, or choose Remind me later
Site ownerWelcome tour settings: turn it on and edit the steps
What you seeWhat it meansWhat to do
The tour does not appear for anyoneEnabled is offOpen the settings and switch on Enabled
One admin never sees the tourThat user’s Show welcome tour is off, or they dismissed itOpen their account and switch on Show welcome tour
A step shows for the wrong peopleThe step Roles or First-run days limit itEdit the step and adjust Roles or clear First-run days
A step is unclear or out of dateThe screen it describes has changedEdit the step’s Description in the settings
The tour keeps interrupting an adminThey want to do it laterThey can choose Remind me later to pause it until tomorrow