Finishing up
Last updated
Last updated
In the previous section, we learned about tasks and gating content. In this section we will finish off our journey by rounding off the lab by adding some tools that can be helpful for you as a content creator. We will be learning how to collect feedback from users, and adding an interactive completion component.
On any page's markdown section, you can add a feedback component your end users can interact with. This can help you source feedback at any point during your lab. Using the feedback component is a great way to continuously improve your content, and find out where your users get stuck or maybe even what is working well.
Let's add a feedback component as a standalone page at the end of the lab.
Let's start by creating a markdown file, that will contain the feedback component. Add the following markdown to a new file instructions/feedback.md.
Start by adding a new page that contains the feedback to pages.hcl
Then add the page to your lab in main.hcl as we've done before.
You can now push your changes and you should see a new chapter with the feedback component present for your users to interact with. Let's continue by adding the comletion component and round out the lab.
As the user reaches the end of the lab, you should provide a way for the user to complete the lab. Outside of giving the user a sense of completion, it will also immediately trigger the shutdown of the lab, stopping infrastructure costs.
You can put this in your content with the Completion component. Let's add the completion component to the feedback page.
Additionally, the Completion component tracks the progress of all tasks and give the user feedback on progress by using our Completion component. It'll show progress, and give the user a CTA to complete the lab once all tasks have been completed.
You can include the completion component anywhere, even before the last page, in which case it will show the progress the user has currently made. This can be an effective way to show the progress to user throughout the entire lab.
Like in the previous sections, you need to git add, git commit and then git push the changes to GitHub.
You can then go to the "Labs" section, verify the latest commit on GitHub matches the status of your lab, and start the lab.
After your page with the task, you should now see another chapter with a feedback component and a completion component. You can leave yourself some feedback and complete the lab by pressing "Stop & Exit".
Congratulations! you have now finished the getting started guide. You should have a good basic understanding of how to build labs with Instruqt.
Best of luck and please reach out to our team if there are any issues with the documentation or product in general.
You can read more about the feedback component in the reference pages .
You can read more about the completion component and how to customize it .
Try building out a simple lab with your own product. There are many more options available which can be find in the documentation and , but you can build most use cases out with what we've learned in this getting started guide.
