Loading experience

Learn how to configure the loading experience for tracks and challenges

When your users start a track or move between challenges the system needs to load the sandbox and tabs (the technology included in your track). Depending on your software, loading a track/challenge can take some time. To keep users engaged, you have the choice of what users can see and interact with while the track or challenge loads.

Loading options

The loading experience has two options: Notes only or Full access.

Notes only

Users can only interact with the notes for the upcoming challenge while they wait for it to finish loading.

The default setting for all tracks

What this looks like:

Users push “Launch” button and the track starts loading. A loading bar is shown on the same screen. While the track is loading the users can only interact with the notes slides.

If you have not added notes, users will see a message asking them to be patient while the challenge loads.

When the loading is complete the users push the “start” button and they enter the first challenge. They now see the challenge assignment and the tabs in the track(lab).

Full access

Users can browse the upcoming challenge notes, assignment and tabs while it loads.

What this looks like:

Users push “Launch” button and the track/challenge starts loading. As the underlying technology loads the user is moved into the upcoming challenge. They can see and interact with the notes and assignment.

Users can click tabs. Any tab that is still loading shows a loading bar and messages. The user cannot move to the next challenge until the current challenge is fully loaded.

The messages are one set per track. You cannot add specific messages per tab.

Create the perfect landing

You can use the layouts capabilities to customise what the lab looks like so users are greeted by the parts of the content you think are most relevant.

How to use

Using the instruqt UI or CLI you can configure the loading experience:

• Per track: the loading experience you select is used for all challenges in that track

• Per challenge: you can override the track setting per challenge

🌐 Web UI

For the track:

1. Select the track you wish to modify the loading experience of.

2. In the Settings section, click Edit.

3. In the Loading part, select the desired loading behaviour.

4. Click Save.

For the challenge:

1. While on the track, select the specific challenge you wish to modify the loading experience of.

2. Make sure you are located in the Details tab.

3. In the Loading part, select the desired loading behaviour.

4. Click Save

💻 Instruqt CLI

1. If you have not already done so, pull the track you wish to modify the time limit of:

   instruqt track pull <track-slug>

2. Open the track.yml file and add a enhanced_loading parameter.

   enhanced_loading: <boolean>

   • Set it to true to enable the assignment loading experience.

   • Set it to false to use the notes loading experience.

   As an example, the file might look like the following:

   slug: example-track
   id: xnlauwy2zewf
   title: Example Track
   ...
   enhanced_loading: true

3. Open the assignment.md file and add a enhanced_loading parameter.

   enhanced_loading: <boolean | null>

   • Set it to null to use the track-level configuration for this challenge.

   • Set it to true to use the assignment loading experience for this challenge.

   • Set it to false to use the notes loading experience for this challenge.

   As an example, the file might look like the following:

   slug: example-challenge
   id: 3s0piwynqvhi
   title: Example Challenge
   ...
   enhanced_loading: null

4. From within the track directory, push the update to Instruqt:

   instruqt track push