-
Notifications
You must be signed in to change notification settings - Fork 10
Learning Labs JSON file parameters
Anne Gentle edited this page Mar 28, 2022
·
10 revisions
Parameter | Description |
---|---|
[ items→ title | Title to be displayed in UI for step. |
items→ content ] | Markdown file name for this step. |
config | These are config details required to instantiate related services for the Learning Lab like DevEnv, video, sandbox, quizzes. Sub services are optional and extendible in the future. |
config→ devEnv | DevEnv: is a dynamic developer environment that provides a console and code editor in the browser. |
config→ devEnv →id | There will be multiple Docker images for devEnv that will have preinstalled SDK and sample code for a specific product. Specify devEnv that should be created as part of this lab |
config→ devEnv →defaultFile | DevEnv will clone a sample code repository that may include code related to multiple Labs. This field will specify a file name that is relevant to a specific lab. |
config → video | Video can be directly embedded in lab step following PubHub markdown syntax. But if the Lab includes an intro video that needs to be previewed before starting, then it can be specified here. |
config → video → URL | video url |
config → video → type | type of video, currently youtube |
config → sandbox | future ( sandbox instantiation using Sandbox API) |
config → sandbox → ID | ID for a sandbox that needs to be reserved or used for this Lab. |
config → sandbox → type | additional details like always on, reservable, or cached, for the orchestrator. |
config → quiz | Quiz will mostly be at module level but if required can be supported a Lab level |
config → quiz → ID | quiz id as created in q&a service |
config → quiz → type | Must pass, percentage, optional |
config → future services*** | Extensible in the future |
meta | Field from existing config files, currently unused |
meta→ slug | Short description of Learning Lab |
meta → time | Estimated time in minutes to complete Lab |
meta → tags | Open-ended tags (Standard metadata catalog tags like the product, technology, programming languages, and so on.) |
meta→ author | Author details, backward compatible (later may be removed) |
meta → byod | Bring Your Own Device true/false, backward compatible (less relevant with DevEnv) |
COPYRIGHT © 2019-2021 CISCO SYSTEMS, INC. ALL RIGHTS RESERVED.