Skip to content
Instruqt Lab Documentation

Overview

The version control feature allows you to collaborate in real-time across the UI and code workflows without accidentally overwriting each others changes and gives you a history of all changes.

Collaborate with confidence

Section titled “Collaborate with confidence”

Multiple team members can work on the same content at the same time without risk of overwriting each other’s changes. If there are conflicting changes made by multiple users, they can be compared, resolved and merged directly in the UI or using git from the command line.

Keep track of changes

Section titled “Keep track of changes”

All changes made to content are stored, and function as an audit log showing who changed what, when, and why the changes were made. The changes include the creation and deletion of files as well as edits to their contents.

Having the complete history and being able to annotate each change with the date, an author and a message describing the purpose and intent of the change, enables you to revert back to previous versions. This capability is crucial when needing to fix problems and being able to compare changes with earlier versions of the content. For instance when doing root cause analysis of bugs, or when trying to figure out why a certain change was made.

Integrate with existing workflows

Section titled “Integrate with existing workflows”

If you are already using version control systems such as GitHub, the new integration allows you to connect your GitHub organization directly to Instruqt without the need for GitHub actions and the Instruqt CLI to push your content. This enables you to use your standard git workflow best practices already adopted by your organization.

Limitations

Section titled “Limitations”

While we continue to improve Labs, there are a few current limitations you should be aware of:

  • Version Control only integrates with GitHub. Other platforms are not supported yet.
  • While you can import a lab from a mono-repository, Labs created through the UI cannot be connected to remote repositories that already contain files.
  • Only Labs using / as their Lab directory can be disconnected. If you import a Lab from a GitHub repository, you will only be able to disconnect it if its path is set to /.

We are actively working to lift these restrictions in future updates.