Using the Briefing Panel Editor

Overview

The Briefing panel contains the core learning content for each lab. It provides users with the essential background knowledge they need before diving into hands-on tasks. This could include an overview of the topic, core concepts, video examples, images, and so on. 

For example, in a lab on SQL injection, the Briefing panel should explain what SQL injection is, how attackers exploit it, how to identify and prevent it in code, and relevant industry examples. The goal is to ensure the user understands the why and how behind the subject before they begin practical work. Think of it as the user's learning foundation—concise, clear, and focused.

The Briefing panel:

• Is a markdown editor that supports various rich media functionality, including headers, links, quotations, in-line code, and code boxes, as well as features such as image and video upload.
• Provides an easy-to-use WYSIWYG (What You See Is What You Get) editor toolbar that is always available at the top of the page when editing.
• Is designed to mimic what the panel will look like on the Immersive One platform. 

Using the Briefing Panel Editor

To use the Briefing panel editor: 

1. On the Lab properties pane, click Briefing.
2. On the Briefing page, click Edit to customize the briefing panel. 
3. Provide the core learning content for each lab using the guidelines described in Briefing Panel Writing Guidance. You can:
   • Add headings.
   • Add lists.
   • Add blockquotes. 
   • Add links. 
   • Add in-line code and code blocks.
   • Upload images.
   • Upload videos.
4. Click Save changes. 

Editor Features

Headings

You can add headings to break up your text and to organize it into sections.

Lists

Standard bulleted lists and ordered lists are supported.

Blockquotes

Blockquotes allow you to break up text and insert stylized quotes.

Links

Links allow you to specify text that has an embedded URL that can be clicked. This is useful if you have external files or documents that you want the user to interact with as part of a lab.

Note: It is the responsibility of the Org Admin who creates the briefing to ensure that all links that are included are safe and/or approved for your users to access.

Code Blocks and In-line Code

The editor supports both:

• In-line code, which can be used for providing examples of small commands. To add in-line code, on the editor toolbar, click the Inline Code button.
• Code blocks, which can be used for multi-line snippets. We support a vast array of languages for code blocks, from C to YAML. To add a code block, on the editor toolbar, click the Code Block button.

Images

You can easily upload images. To do so:

1. On the editor toolbar, click the Upload Image button. 

   

2. After clicking this button, a dialog box appears, letting you choose your image from your local computer. 
   Note: Image uploads are restricted to .png, jpg (or .jpeg), .gif, or .webp format. 
   

3. Once an image has been selected, the Add image dialog box appears, which will let you review the image and add alt-text.

   

   • Alt text (alternative text) describes the content or function of an image. It’s important for accessibility (screen readers) and ensures information isn’t lost if the image doesn’t load. Use clear, concise descriptions relevant to the image’s purpose.
   • If you upload a large image, you can also crop it if needed using the Crop image tool. 
     
     This crop tool can allow you to select the part of the image that you want for the lab.
     

Videos

The editor also allows you to upload videos. To do so: