Glossary
You can customize the look of your tracks and invites to suit your brand. To do so, follow below steps:
🌐 Web UI
Second Tab
- Hover over the branding bar and click Edit Branding. ↳ Instruqt shows a sidebar at the right with Branding settings.
- In the Title field, enter a title. ↳ Notice that Instruqt changes the title as you type.
- Click one of the colors from the Background color section. ↳ Notice that Instruqt immediately changes the background color.
- Apply values to the other settings to suit your brand.
Challenges are individual incremental steps in a track. A challenge comes with a concrete assignment for the learner, and you can add scripts that check if the learner completed the challenge. The check script and all other lifecycle scripts execute on the sandbox host.
As a part of the sandbox environment, you can add a Google Cloud project, AWS credentials, or an Azure subscription. Instruqt makes sure the credentials are available on the hosts in the sandbox. For example, if you connect a Google Cloud project, the command line interface
gcloud is available on the host, logged in, and configured to use that project. That's you! You're building tracks on the platform and you are part of a team on Instruqt.
Hot starting is creating a pool of sandboxes that are instantly available when a learner starts your track.
Instruqt provides a CLI tool that you can install on your local machine. With Instruqt CLI, you can download track configuration. Using a text editor, you can work on your track and upload it to deploy the changes.
A learner is someone playing a track. Depending on your context, you might refer to a learner as a student, prospect, lead, or customer.
Four scripts execute on sandbox hosts as a part of the challenge lifecycle:
- Setup
- Check
- Solve
- Cleanup
An additional track cleanup script also executes before the sandbox environment stops. Lifecycle scripts always run on a sandbox host.
A member is part of a team and has one of the following roles:
- Owner
- Content creator
- Member
As a team owner, you can invite new team members as following:
🌐 Web UI
Second Tab
- Click Manage team. ↳ Instruqt shows the Manage team members page.
- In the Invite more members field, enter the member's email address you want to add. ↳ Notice that the Send invite shows up after you enter the email address.
- In the Role list, select the role you want to assign.
- Click Send invite.
Before the learner starts a challenge, notes show on the screen. Notes are where you can provide additional context for an assignment. Every challenge has notes. They are a great way to keep the learner engaged while waiting for the setup script of the challenge to complete. You can also use notes to show:
- Videos
- Images
- Fun facts
- Quotes
The Quiz is a special type of challenge that tests your learners' knowledge by asking them multiple-choice questions. A quiz requires a correct answer before the learner can continue to the next challenge. Quizzes are a great way to break up your track and keep it interesting.
A role defines a member's permissions and Instruqt has the following roles:
- Owner
- Content creator
- Member
The following table shows the permissions per role:
Permission | Owner | Content creator | Member |
|---|---|---|---|
Manage team members | ✔ | | |
✔ | | | |
✔ | | | |
Set track play limits | ✔ | | |
✔ | ✔ | | |
✔ | ✔ | | |
✔ | ✔ | |
The sandbox environment starts on-demand when a user starts a track. You can also enable the hot start feature to preheat your sandboxes. Sandboxes can have containers, virtual machines, and cloud accounts in them. Learners access the environment from a pre-authorized container or virtual machine to use cloud resources.
A sandbox host is either a container or a virtual machine. Instruqt patches the sandbox host to provide the learner with shell access and optional cloud resources. You can use sandbox hosts as a workstation, server, or both.
Tabs define the components that the learner can work with inside a challenge.
A team is where Instruqt groups you and your colleague content developers as members. And all members have access to the tracks created within the team.
Templates are track skeletons based on commonly used sandbox type
A collection of tracks. You can use them to group tracks that are part of a workshop or tracks that form a learning journey.
Tracks are the main building blocks for content on Instruqt. A track guides learners through a series of challenges in a sandbox environment. Learners typically perform their tasks in a web-based shell that runs on a sandbox host.
Track Invites allow you to share one or more tracks with learners using a link.
The Instruqt web app with which you can develop, play, and manage tracks. To start the Web UI, open your browser and navigate to: https://play.instruqt.com/
Last modified 10d ago