Share a track
Roll out your work to the learners.
This guide explains how to share a track from Web UI and Instruqt CLI.
If it is time to send your track into the world, share your track so learners can play the track.

Accessibility

Sharing your track is all about making it accessible to learners in one of the following ways:
  • ​Invite people to a track.
  • ​Embed a track on your website.

Track options

Furthermore, Instruqt has these track options that you want to consider:
  • If a track is in maintenance.
  • If a track shows a timer during playing.
  • If you allow learners to skip challenges.
In Web UI you set these options as option toggles. In Instruqt CLI you set these options as option properties in the track.yml configuration file. The following table contains the options settings and properties:
🌐 Web UI
πŸ’» Instruqt CLI
  • In maintenace
  • Show countdown timer
  • Allow skipping
Configuration file track.yml:
  • maintenance
  • show_timer
  • skipping_enabled

Share

Pick the Web UI or the Instruqt CLI route depending on your preference:
🌐 Web UI
πŸ’» Instruqt CLI

Before you begin

Make sure you have opened the Track overview page of the track you want to share.

Share

  1. 1.
    Decide how you want to share your track. Then either
    or
  2. 2.
    Set the track Track options. In maintenance If you want to maintain your track, turn on the In maintenance toggle. Show countdown timer If you want a timer shown during track play, turn on the Track shows countdown timer toggle. Allow skipping If you want that learners can skip one or more challenges in a track, turn on the Allow skipping toggle.
  1. 1.
    Decide how you want to share your track. Then either
    or
  2. 2.
    Open the track.yml file in your code editor.
  3. 3.
    Set the Track options properties: In maintenance If you want to maintain your track, set the following property:
    1
    maintenance: true
    Copied!
    Show countdown timer If you want a timer shown during track play, set the following property:
    1
    show_timer: true
    Copied!
    Allow skipping If you want that learners can skip one or more challenges in a track, set this property:
    1
    skipping_enabled: true
    Copied!
  4. 4.
    Save the track.yml file.
  5. 5.
    Push the track to the Instruqt platform:
    1
    instruqt track push
    Copied!
Fantastic! Your track is now out in the world.
Copy link
Edit on GitHub