Intro

Content guideline for the Intro

Eva Tjitske Jansen avatar
Written by Eva Tjitske Jansen
Updated over a week ago

An intro is the first thing a new user sees when opening the platform.

This is the place where you can highlight certain features you want your users to know and give a short general introduction.

If you want to make new employees feel welcome, this is the place!

A good intro should contain:

  • a welcome message

  • some features you want to highlight and some information on how to use those features


How to create an Intro📚

Go to Content Builder, create a child page with the Walkthrough format in a Pages folder, and fill in the fields.

Fields in the Content Builder

Fields marked with a * are mandatory:

  • Content ID* = A unique identifier for the intro. Only shown in the content builder.

    Items

    By clicking on the '+' sign, you can choose between two types of slides in the intro:

  • Image slide

    • Image + image alt = Image uploader for JPG, PNG, GIF formats. In the 'Alt' section, add an image description for accessibility purposes (e.g. for blind users with a screen reader). Tip: the intro looks best if a square PNG image is used with a transparent background.

    • Heading (text only) = A heading that will be shown for the user.

    • Text (rich text) = A body text that supports bulleted or numbered lists, hyperlinks, bold and italic texts.

  • Video slide

    • Video URL = URL (e.g. from Vimeo, YouTube). These videos cannot be styled since they will adopt the styling of the video player of whatever website they are coming from.

    • Video upload + thumbnail = Video uploader for MP4 with H.264 codec. + Image uploader (JPG, PNG, GIF) for a video thumbnail.

    • Heading (text only) = A heading that will be shown for the user.

    • Text (rich text) = A body text that supports bulleted or numbered lists, hyperlinks, bold and italic texts.

Once you are happy with your intro don’t forget to push it!

☝ Tip: It is important to keep in mind that a very long intro with too much information can be demotivating for the user. We advise to not use more than five slides in the intro.


Good to know 👀

  • The user sees the intro upon visiting the platform for the first time. They can click through the slides that give a short explanation about the platform. At the end, the user is directed to the Intake or Discovery Stream.

  • If a user has access to an intro, it will be shown directly on the first login (or the first time an intro is added to the platform).

  • After the first visit, a user can always revisit the Intro(s) through the menu. By default, it is called Intro.

  • If a user has no access to any intros, the menu will not show the 'Intro' button. If the user tries to go to /#/intro manually, an error dialogue will be shown with a message "You have no access to this content" with a "Back to dashboard" button.

  • If a user has access to multiple intros, all intros will show one after another. The user is considered to have completed the intros when they press the "done" button at the end of the last Intro.

Did this answer your question?