Skip to content

Learning Labs JSON file parameters

Anne Gentle edited this page Jul 11, 2019 · 10 revisions
Parameter Description
labID Identifying name string. Must match the folder in which the lab resides; cannot contain spaces.
title Lab title, using Sentence case.
slug Brief summary of what the lab teaches.
time Number of minutes required to complete the lab.
byod Note: When there is no byod.html file, regardless of this setting, the system displays a yellow banner that says you must be at an event or Cisco Live! in order to complete the Lab.

true: Enables the blue "How To Setup Your Own Computer" banner on the lab. Typical setting. false: Disables the banner. | | files | List of files that comprise the lab. | | title | Title for the page for that file, such as Step 1: Reading and writing files. | | file | Name of the file for the page, such as 1.md. | | tags | Defines the tags for the lab that will appear in the Learning Labs Tags list. | | title | Name of tag, using a common set of tag titles. | | redirectTo | Defines the labId for client-side redirect of one Lab to a new Lab URL. | | related | Labs related to the current lab. The labId and title must be defined for each related lab. | | labID | Lab ID for the related lab. | | title | Title of the related lab. | | authors | Name and email address of the author, can list multiple authors. | | active | true: The lab is available on the Learning Labs site. false: The lab is disabled and not visible. | | moduleOnly | true: The lab is available on the Learning Labs site. false: The lab is disabled and not visible. |