Skip to main content
Keel Docs Showcase

First-time tour

The first time you open Keel, a short tour shows you where things are. The screen dims and one area or button at a time lights up, with a small card next to it: what it is for, in one or two sentences, and how far you are (3 of 16).

It only points things out. It never changes anything, and you don't have to click anything on the page. For a moment it opens the first list and its first item, so it can show you the editor's buttons. At the end you are back where you started.

What it shows

There are up to 16 steps, in the order they appear on screen:

#StepWhat it points out
1Welcome to KeelA card in the middle: what the tour is
2Market switcherOnly when the project has one: pick one to see only its content; All shows everything
3Find anythingCtrl K finds items in all your lists, opens a list or adds an item; every list also has its own search (/)
4Notifications and moreThe bell, View website, and ⋯ with Refresh, Dark mode and Full screen
5The menuOnly the area you are in is open; starred lists stay under Favourites at the top (and the outlined number of items assigned to you, with assignments)
6TeamAdmins only: everyone and their open work
7DocumentsWhen you may edit pages: the content editor – type on the page, add sections with +, click an image to change it, Preview shows unsaved changes; and the Keel page check tab
8AssetsWhen there are files: upload by dropping, the duplicate check, alt texts, usage rights, focal point, formats, where a file is used
9SetupData model, History and My view; Bulk jobs; for admins Customize, Completeness, Field access and Scripts & tracking
10OverviewThe numbers at the top and the cards below them
11Quick filtersThe one row of chips above a list; Published and Drafts are under Filter
12Search, columns, filterThe list's search, Columns, Filter, Export / Import and New …
13Open an itemA row, its buttons at the end and the schedule clock; with assignments, the Assigned to name
14The itemThe editor's header: assignee, languages, Published, Preview, Follow and ⋯
15Fields and historyThe tabs, with History (and Activity) at the end; Ctrl S saves, Esc or ✕ closes
16That's itThe ? button: keyboard shortcuts and the tour again

You only see what you can use: steps for admins or for things your project doesn't have are left out, and a step whose spot isn't on your screen is skipped.

Moving through it

Next step / → / EnterThe next step
Back / ←The step before
Skip tour / EscEnd the tour now

On a phone or in a narrow window the card sits at the bottom of the screen, or at the top when the lit area is low down.

Once per person

The tour starts by itself once per user. When you finish or skip it, Keel remembers that with your user, so it doesn't come back in another browser or on another computer. Reset all to team default in My view doesn't bring it back either.

Take it again

The ? button at the top right of Keel's header → Take the tour starts it again, any time.

For admins

To stop the tour from starting by itself, for everyone on this installation, set this in keel.yaml:

yaml
keel:
    tour:
        auto_start: false

Take the tour stays in the ? menu. See the keel.yaml reference.

Automated browser tests can switch off the automatic start for one browser. Set localStorage keel-tour to off before Keel loads, as Keel's own stress tests do.

The tour is in Pimcore Studio. The classic admin doesn't have it.